Desarrolladores

Referencia de funciones de Zinn® Chat

Zinn® Chat registra sus acciones en la WordPress Abilities API. Las mismas capacidades son herramientas MCP en el propio servidor del sitio y rutas REST bajo /wp-json/wp-abilities/v1. Esta página se genera a partir del propio registro del plugin.

Guía del usuario: conectar una aplicación de IA

Zinn®, nuestro vikingo, vitorea mientras un asistente de IA se conecta a las herramientas de la plataforma.

Endpoints

MCP sobre HTTP (transmisible)

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

MCP sobre WP-CLI (entrada y salida estándar)

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

REST: listar las habilidades

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

REST: ejecutar una habilidad

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

Autenticación y permisos

Las solicitudes HTTP se autentican con una contraseña de aplicación de WordPress (HTTP Basic). Conectarse al servidor MCP requiere la capacidad que se muestra a continuación; cada función verifica luego su propio permiso, por objeto. Las funciones de solo lectura se ejecutan con GET y su entrada en la cadena de consulta; las demás con POST y un cuerpo JSON {«input»: {…}}.

Ejemplos

# REST: ejecutar una habilidad
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":{}}}

Todas las capacidades

Generado a partir del archivo abilities.json del plugin, que a su vez se genera a partir de un sitio en ejecución; una prueba falla cuando ambos no coinciden.

CapacidadQué haceEdiciónRESTOPermisoParámetros
zinn-chat/answer-ticket
zinn-chat-answer-ticket
Responder a un ticket
Responde al cliente por correo electrónico (text) o añade una nota interna (note: true); status cambia opcionalmente el estado del ticket.
Edición gratuitaPOST …/abilities/zinn-chat/answer-ticket/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/ask-assistant
zinn-chat-ask-assistant
Pregunta al asistente
Hace una pregunta al asistente de IA del sitio y devuelve su respuesta con cada una de las fuentes encontradas.
Edición gratuitaPOST …/abilities/zinn-chat/ask-assistant/runthe REST route's own per-item permission checkquestion: string (obligatorio), language: string
zinn-chat/bulk-update-tickets
zinn-chat-bulk-update-tickets
Cambia varias entradas a la vez (Pro)
Cambia el estado, la prioridad o la persona asignada de hasta 100 tickets (ids). Cada ticket pasa por las mismas comprobaciones que si lo cambiaras por separado; el resultado muestra cada uno de ellos.
Edición ProPOST …/abilities/zinn-chat/bulk-update-tickets/runzinn_chat_answerids: array (obligatorio), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer
zinn-chat/chat-to-ticket
zinn-chat-chat-to-ticket
Convierte un chat en un ticket
Abre un ticket a partir de un chat para que pueda responderse por correo electrónico (necesita la dirección de correo electrónico del visitante).
Edición gratuitaPOST …/abilities/zinn-chat/chat-to-ticket/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/close-chat
zinn-chat-close-chat
Cerrar un chat
Finaliza un chat; el visitante aún puede solicitar la transcripción.
Edición gratuitaPOST …/abilities/zinn-chat/close-chat/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/create-ticket
zinn-chat-create-ticket
Abrir un ticket
Abre un ticket en nombre de un cliente (su correo electrónico, un asunto y el primer mensaje).
Edición gratuitaPOST …/abilities/zinn-chat/create-ticket/runthe REST route's own per-item permission checkemail: string (obligatorio), subject: string (obligatorio), body: string (obligatorio), name: string
zinn-chat/delete-canned-reply
zinn-chat-delete-canned-reply
Eliminar una respuesta guardada (Pro)
Elimina una respuesta guardada.
Edición ProPOST …/abilities/zinn-chat/delete-canned-reply/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/delete-ticket
zinn-chat-delete-ticket
Eliminar un ticket
Elimina un ticket y su conversación de forma permanente (solo administradores).
Edición gratuitaPOST …/abilities/zinn-chat/delete-ticket/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/draft-kb-article
zinn-chat-draft-kb-article
Redacta un borrador de artículo de ayuda a partir de un ticket (Pro)
Escribe un borrador de artículo de base de conocimientos a partir de un ticket resuelto; se mantiene como borrador hasta que alguien lo publique.
Edición ProPOST …/abilities/zinn-chat/draft-kb-article/runedit_posts (the REST route's own check)ticket: integer (obligatorio)
zinn-chat/draft-kb-from-gaps
zinn-chat-draft-kb-from-gaps
Crea borradores de artículos de ayuda para preguntas sin respuesta (Pro)
Escribe borradores de artículos de la base de conocimiento que responden a las preguntas seleccionadas (id); se quedan como borradores.
Edición ProPOST …/abilities/zinn-chat/draft-kb-from-gaps/runedit_posts (the REST route's own check)ids: array (obligatorio)
zinn-chat/fill-canned-reply
zinn-chat-fill-canned-reply
Rellena una respuesta guardada (Pro)
Devuelve el texto de una respuesta guardada con sus marcadores de posición completados para un chat o ticket.
Edición ProPOST …/abilities/zinn-chat/fill-canned-reply/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/get-chat
zinn-chat-get-chat
Leer un chat
Devuelve los mensajes de un chat y los detalles del visitante (after: solo mensajes posteriores a este id).
Edición gratuitaGET …/abilities/zinn-chat/get-chat/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/get-overview
zinn-chat-get-overview
Lee el resumen de soporte
Devuelve cuántos tickets hay en cada estado, cuántos chats están esperando a una persona (y sus mensajes no leídos), y si el chat, el asistente y los tickets están activados.
Edición gratuitaGET …/abilities/zinn-chat/get-overview/runzinn_chat_answerNinguno
zinn-chat/get-settings
zinn-chat-get-settings
Lee los ajustes del chat
Devuelve todos los ajustes del chat: el widget, el asistente, las personas y el horario de atención, los tickets y el correo electrónico, el índice del sitio, la privacidad y el spam.
Edición gratuitaGET …/abilities/zinn-chat/get-settings/runzinn_chat_manageNinguno
zinn-chat/get-stats
zinn-chat-get-stats
Leer estadísticas de soporte (Pro)
Devuelve el número de chats y tickets, tiempos de respuesta y valoraciones de los últimos N días (días).
Edición ProGET …/abilities/zinn-chat/get-stats/runthe REST route's own per-item permission checkdays: integer
zinn-chat/get-ticket
zinn-chat-get-ticket
Leer un ticket
Devuelve un ticket con toda su conversación, estado, prioridad y persona asignada.
Edición gratuitaGET …/abilities/zinn-chat/get-ticket/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/hand-chat-to-assistant
zinn-chat-hand-chat-to-assistant
Devuelve el chat al asistente
Devuelve un chat al asistente de IA, que responde al visitante a partir del contenido del sitio.
Edición gratuitaPOST …/abilities/zinn-chat/hand-chat-to-assistant/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/list-canned-replies
zinn-chat-list-canned-replies
Listar respuestas guardadas (Pro)
Muestra las respuestas guardadas que los agentes pueden insertar, junto con sus atajos.
Edición ProGET …/abilities/zinn-chat/list-canned-replies/runthe REST route's own per-item permission checkNinguno
zinn-chat/list-chats
zinn-chat-list-chats
Listar chats en vivo
Muestra una lista de los chats en espera, en curso y cerrados recientemente, junto con la persona encargada de cada uno.
Edición 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
Lista lo que el asistente sabe
Muestra el contenido a partir del cual responde el asistente, con su estado de indexación, página por página.
Edición 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 preguntas sin respuesta (Pro)
Muestra las preguntas que hicieron los visitantes y que la base de conocimientos no pudo responder.
Edición 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 tickets
Muestra una lista de tickets de soporte, filtrados por estado o búsqueda, una página a la vez.
Edición 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 el índice de búsqueda del asistente
Reconstruye los vectores de búsqueda para un elemento (item_id) o para todo (all: true) (solo administradores).
Edición 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
Vuelve a leer el contenido en el asistente
Vuelve a leer un elemento (item_id) o todo (all: true) en el índice del asistente (solo para administradores).
Edición 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 en el chat
Envía un mensaje al visitante (text) o añade una nota interna que solo ven los agentes (note: true).
Edición gratuitaPOST …/abilities/zinn-chat/reply-chat/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/save-canned-reply
zinn-chat-save-canned-reply
Guarda una respuesta guardada (Pro)
Crea o modifica una respuesta guardada (título, atajo, cuerpo, departamento; id para modificar una).
Edición ProPOST …/abilities/zinn-chat/save-canned-reply/runthe REST route's own per-item permission checkid: integer, title: string (obligatorio), body: string (obligatorio), shortcut: string, department: string
zinn-chat/save-kb-article
zinn-chat-save-kb-article
Escribe un artículo de ayuda (Pro)
Crea un artículo de la base de conocimiento o modifica uno (id): título, contenido, extracto, categorías y estado (borrador o publicar cuando puedas publicar).
Edición 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
Busca en la base de conocimiento (Pro)
Encuentra artículos de ayuda para enlazar en una respuesta (q: la búsqueda).
Edición ProGET …/abilities/zinn-chat/search-kb/runthe REST route's own per-item permission checkq: string (obligatorio)
zinn-chat/set-conversation-details
zinn-chat-set-conversation-details
Establece el departamento y las etiquetas de una conversación (Pro)
Establece el departamento y las etiquetas de un chat o ticket (kind: chat o ticket; id).
Edición ProPOST …/abilities/zinn-chat/set-conversation-details/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obligatorio), department: string, tags: array
zinn-chat/set-kb-gap-status
zinn-chat-set-kb-gap-status
Marcar preguntas sin responder (Pro)
Marca las preguntas sin respuesta como abiertas, planificadas o descartadas (ids, status).
Edición ProPOST …/abilities/zinn-chat/set-kb-gap-status/runthe REST route's own per-item permission checkids: array (obligatorio), status: open|drafted|answered|ignored (obligatorio)
zinn-chat/set-presence
zinn-chat-set-presence
Configura tu disponibilidad
Marca al agente que ha iniciado sesión como disponible o ausente para nuevos chats (away: true o false).
Edición gratuitaPOST …/abilities/zinn-chat/set-presence/runthe REST route's own per-item permission checkaway: boolean
zinn-chat/suggest-reply
zinn-chat-suggest-reply
Redacta una respuesta con IA (Pro)
Crea un borrador de respuesta a un chat o ticket a partir del contenido del sitio; no se envía nada.
Edición ProPOST …/abilities/zinn-chat/suggest-reply/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obligatorio)
zinn-chat/summarise-conversation
zinn-chat-summarise-conversation
Resume una conversación con IA (Pro)
Resume un chat o ticket en unas pocas líneas.
Edición ProPOST …/abilities/zinn-chat/summarise-conversation/runthe REST route's own per-item permission checkkind: ticket|chat, id: integer (obligatorio)
zinn-chat/take-chat
zinn-chat-take-chat
Aceptar un chat
Asigna un chat en espera al agente que ha iniciado sesión, para que el visitante hable con una persona.
Edición gratuitaPOST …/abilities/zinn-chat/take-chat/runthe REST route's own per-item permission checkid: string (obligatorio)
zinn-chat/update-settings
zinn-chat-update-settings
Cambia los ajustes del chat
Cambia los ajustes que envías (ajustes: clave a valor) y conserva el resto. Cada valor se comprueba exactamente como en la pantalla de ajustes; get-settings lista las claves.
Edición gratuitaPOST …/abilities/zinn-chat/update-settings/runzinn_chat_managesettings: object (obligatorio)
zinn-chat/update-ticket
zinn-chat-update-ticket
Cambiar un ticket
Cambia el estado, la prioridad o el asignado de un ticket.
Edición gratuitaPOST …/abilities/zinn-chat/update-ticket/runthe REST route's own per-item permission checkid: string (obligatorio)

Acciones y filtros

Cada gancho que ofrece el plugin, con la descripción de su código fuente. Los filtros cambian un valor; las acciones permiten ejecutar código en un momento determinado; los puntos de entrada son acciones que se ejecutan para solicitar al plugin que realice una tarea.

WebhookClaseQué haceParámetrosEdición
zinn_chat_admin_pagesFiltrarFiltra las pantallas de administración de Zinn® Chat (Pro añade las suyas propias).NingunoEdición gratuita
zinn_chat_agent_chatFiltrarFiltra el contenido del chat para la consola del agente (Pro añade detalles del visitante, notas y sugerencias de la base de conocimientos).NingunoEdición gratuita
zinn_chat_agent_pagesFiltrarFiltra las pantallas de Zinn® Chat que puede abrir una cuenta de agente de soporte.NingunoEdición Pro
zinn_chat_agent_script_srcFiltrarFiltra la URL desde la que se carga el agente de chat de IA independiente.string $srcEdición gratuita
zinn_chat_agent_ticketFiltrarFiltra la carga útil de los tickets para wp-admin (Pro añade respuestas predefinidas, SLA, sugerencias de base de conocimientos).NingunoEdición gratuita
zinn_chat_answerFiltrarFiltra la respuesta de un asistente antes de que se muestre (Pro añade sus extras aquí).string $questionEdición gratuita
zinn_chat_assistant_answeredAcciónEl asistente respondió a un visitante.int $id, string $textEdición gratuita
zinn_chat_challengeFiltrarFiltra la verificación humana que se muestra a los visitantes (la URL del script, la clave del sitio y el objeto global que el script define con un método `render( element, { sitekey, callback } )`).NingunoEdición gratuita
zinn_chat_challenge_okFiltrarFiltra si el visitante superó la comprobación humana. Una comprobación que no se pueda verificar debe devolver falso (bloqueo ante fallos): un formulario que lo permite todo cuando el servicio no está accesible es un formulario que un bot puede hacer que tenga éxito mediante temporización.bool $ok, string $ip, string $whereEdición gratuita
zinn_chat_client_ipFiltrarFiltra la dirección IP del visitante utilizada para los límites de tasa y los registros.string $ipEdición gratuita
zinn_chat_console_configFiltrarFiltra la configuración adicional proporcionada al script de la consola del operador; Zinn® Chat Pro añade sus características aquí.NingunoEdición gratuita
zinn_chat_conversation_startedAcciónUn visitante ha iniciado un chat.int $idEdición gratuita
zinn_chat_conversation_statusAcciónUna conversación cambió de estado.int $id, string $status, string $oldEdición gratuita
zinn_chat_customer_ticket_urlFiltrarFiltra el enlace que se le envía a un cliente para su ticket.string $urlEdición gratuita
zinn_chat_elementsFiltrarFiltra los elementos del front-end ofrecidos como bloques y módulos del constructor.NingunoEdición gratuita
zinn_chat_emailFiltrarFiltra un correo electrónico antes de ser enviado. Devuelve un `to` vacío para detenerlo.NingunoEdición gratuita
zinn_chat_fs_loadedAcciónSe dispara una vez que el SDK de licencias se ha cargado (en el archivo principal, antes de cualquier código de Zinn® Chat). Utilice este gancho para interactuar con `zinn_chat_fs()`.NingunoEdición gratuita
zinn_chat_index_extractFiltrarFiltra un objeto extraído (o proporciona uno para un tipo de objeto personalizado).string $type, int $idEdición gratuita
zinn_chat_index_languageFiltrarFiltra el idioma (configuración regional) de una publicación indexada.string $language, \WP_Post $postEdición gratuita
zinn_chat_index_objectPunto de entrada (se inicia)HooksNingunoEdición gratuita
zinn_chat_index_post_typesFiltrarFiltra los tipos de publicaciones que lee el asistente.NingunoEdición gratuita
zinn_chat_indexableFiltrarFiltra si una publicación está indexada.bool $indexable, \WP_Post $postEdición gratuita
zinn_chat_indexedAcciónSe ha indexado (o reindexado) un objeto.string $type, int $idEdición gratuita
zinn_chat_is_proFiltrarFiltra si las funciones Pro se ejecutan (una licencia comprada o una prueba, de Freemius). El código Pro se incluye solo en el paquete prémium, por lo que esto no puede agregar lo que le falta al gratuito.bool $proEdición gratuita
zinn_chat_loadedAcciónZinn® Chat se ha cargado (el punto de extensión para complementos).NingunoEdición gratuita
zinn_chat_message_addedAcciónSe ha añadido un mensaje a una conversación.int $id, int $conversation_id, string $roleEdición gratuita
zinn_chat_order_trackingFiltrarFiltra la información de seguimiento proporcionada al asistente para un pedido.\WC_Order $orderEdición gratuita
zinn_chat_pro_alertAcciónHa ocurrido un evento digno de alerta (las notificaciones push se escuchan aquí).string $alert, int $id, string $text, string $linkEdición Pro
zinn_chat_pro_assignedAcciónSe ha asignado un ticket a un agente automáticamente.int $id, int $agentEdición Pro
zinn_chat_pro_loadedAcciónSe ha cargado la capa Pro.NingunoEdición Pro
zinn_chat_pro_priority_changedAcciónLa prioridad de un ticket ha cambiado (los objetivos de SLA se ajustan a ella).int $idEdición Pro
zinn_chat_pro_sla_breachAcciónSe ha incumplido un objetivo de SLA.int $ticket_id, string $whichEdición Pro
zinn_chat_pro_ticket_ratedAcciónUn cliente calificó un ticket resuelto (1-5).int $id, int $scoreEdición Pro
zinn_chat_ratedAcciónSe activa después de que un visitante califica una conversación, con el identificador de la conversación y la calificación (1 si fue útil, -1 si no lo fue).int $conversation_id, int $ratingEdición gratuita
zinn_chat_role_capabilitiesFiltrarFiltra qué roles reciben qué capacidades de Zinn® Chat.NingunoEdición gratuita
zinn_chat_save_settingsFiltrarFiltra la configuración antes de que se almacene (Pro añade sus propias claves aquí).NingunoEdición gratuita
zinn_chat_script_srcFiltrarFiltra la URL desde la que se carga el widget de chat alojado (modo conectado).string $srcEdición gratuita
zinn_chat_settings_beforeAcciónSalida sobre el formulario de una pestaña de configuración.string $tabEdición gratuita
zinn_chat_settings_fieldsFiltrarFiltra los campos de una pestaña de configuración (Pro añade los suyos propios).string $tabEdición gratuita
zinn_chat_settings_tabsFiltrarFiltra las pestañas de configuración.NingunoEdición gratuita
zinn_chat_setup_afterAcciónResultado bajo la lista de comprobación de configuración (la edición gratuita muestra la tarjeta Pro aquí).NingunoEdición gratuita
zinn_chat_should_renderFiltrarFiltra si el chat se muestra en esta solicitud (los ganchos de segmentación de páginas de Pro se conectan aquí).bool $renderEdición gratuita
zinn_chat_site_factsFiltrarFiltra los datos sobre el sitio que se proporcionan al asistente con cada pregunta. Cada uno contiene `title`, `url` (en este sitio) y `text` (texto sin formato, como máximo 3000 caracteres); se utilizan como máximo cuatro.string $languageEdición gratuita
zinn_chat_site_stringsFiltrarFiltra los textos del propietario ofrecidos para traducción (Pro añade sus mensajes proactivos).NingunoEdición gratuita
zinn_chat_system_promptFiltrarFiltra el mensaje del sistema del asistente (Pro: reglas de personalidad y transferencia).string $rulesEdición gratuita
zinn_chat_team_onlineFiltrarFiltra si una persona puede responder ahora (Pro añade el horario comercial aquí).bool $onlineEdición gratuita
zinn_chat_ticket_assignedAcciónAn agent assigned a ticket to an agent (2.14.0: the notification centre tells them).int $id, int $assignee, int $byEdición gratuita
zinn_chat_ticket_createdAcciónSe ha abierto un ticket. El servicio de correo envía la confirmación y la alerta al equipo desde aquí.int $id, string $tokenEdición gratuita
zinn_chat_ticket_form_extraFiltrarFiltra el marcado adicional al final de un formulario de ticket de invitado (la verificación humana de Pro va aquí).string $htmlEdición gratuita
zinn_chat_ticket_form_fieldsFiltrarFiltra los campos adicionales que se muestran arriba del mensaje en cada formulario de ticket (Pro: una opción de departamento). Nómbralos `zinn_chat_extra[<key>]`; llegan a `zinn_chat_ticket_created` como `$fields['extra']`, sin sanear, para que quien los haya añadido los valide.string $htmlEdición gratuita
zinn_chat_ticket_replyAcciónSe ha añadido una respuesta a un ticket. El remitente envía un correo electrónico a la otra parte desde aquí.int $id, int $ticket_id, string $authorEdición gratuita
zinn_chat_ticket_statusAcciónUn ticket ha cambiado de estado.int $id, string $status, string $oldEdición gratuita
zinn_chat_uninstallAcciónZinn® Chat se está desinstalando (Pro elimina sus propios datos aquí).NingunoEdición gratuita
zinn_chat_widget_configFiltrarFiltra la configuración del lanzador impresa en la página.NingunoEdición gratuita
zinn_chat_widget_statusFiltrarFiltra lo que recibe el chat abierto (Pro añade sus propios conmutadores y palabras).NingunoEdición gratuita