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.
Endpoints
MCP sobre HTTP (transmisible)
https://example.com/wp-json/zinn-chat/v1/mcpMCP 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-chatREST: ejecutar una habilidad
/wp-json/wp-abilities/v1/abilities/<name>/runAutenticació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.
| Capacidad | Qué hace | Edición | RESTO | Permiso | Parámetros |
|---|---|---|---|---|---|
zinn-chat/answer-ticketzinn-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 gratuita | POST …/abilities/zinn-chat/answer-ticket/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/ask-assistantzinn-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 gratuita | POST …/abilities/zinn-chat/ask-assistant/run | the REST route's own per-item permission check | question: string (obligatorio), language: string |
zinn-chat/bulk-update-ticketszinn-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 Pro | POST …/abilities/zinn-chat/bulk-update-tickets/run | zinn_chat_answer | ids: array (obligatorio), status: open|pending|solved|closed, priority: low|normal|high|urgent, assignee_id: integer |
zinn-chat/chat-to-ticketzinn-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 gratuita | POST …/abilities/zinn-chat/chat-to-ticket/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/close-chatzinn-chat-close-chat | Cerrar un chat Finaliza un chat; el visitante aún puede solicitar la transcripción. | Edición gratuita | POST …/abilities/zinn-chat/close-chat/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/create-ticketzinn-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 gratuita | POST …/abilities/zinn-chat/create-ticket/run | the REST route's own per-item permission check | email: string (obligatorio), subject: string (obligatorio), body: string (obligatorio), name: string |
zinn-chat/delete-canned-replyzinn-chat-delete-canned-reply | Eliminar una respuesta guardada (Pro) Elimina una respuesta guardada. | Edición Pro | POST …/abilities/zinn-chat/delete-canned-reply/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/delete-ticketzinn-chat-delete-ticket | Eliminar un ticket Elimina un ticket y su conversación de forma permanente (solo administradores). | Edición gratuita | POST …/abilities/zinn-chat/delete-ticket/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/draft-kb-articlezinn-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 Pro | POST …/abilities/zinn-chat/draft-kb-article/run | edit_posts (the REST route's own check) | ticket: integer (obligatorio) |
zinn-chat/draft-kb-from-gapszinn-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 Pro | POST …/abilities/zinn-chat/draft-kb-from-gaps/run | edit_posts (the REST route's own check) | ids: array (obligatorio) |
zinn-chat/fill-canned-replyzinn-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 Pro | POST …/abilities/zinn-chat/fill-canned-reply/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/get-chatzinn-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 gratuita | GET …/abilities/zinn-chat/get-chat/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/get-overviewzinn-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 gratuita | GET …/abilities/zinn-chat/get-overview/run | zinn_chat_answer | Ninguno |
zinn-chat/get-settingszinn-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 gratuita | GET …/abilities/zinn-chat/get-settings/run | zinn_chat_manage | Ninguno |
zinn-chat/get-statszinn-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 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 | Leer un ticket Devuelve un ticket con toda su conversación, estado, prioridad y persona asignada. | Edición gratuita | GET …/abilities/zinn-chat/get-ticket/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/hand-chat-to-assistantzinn-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 gratuita | POST …/abilities/zinn-chat/hand-chat-to-assistant/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/list-canned-replieszinn-chat-list-canned-replies | Listar respuestas guardadas (Pro) Muestra las respuestas guardadas que los agentes pueden insertar, junto con sus atajos. | Edición Pro | GET …/abilities/zinn-chat/list-canned-replies/run | the REST route's own per-item permission check | Ninguno |
zinn-chat/list-chatszinn-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 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 | 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 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 preguntas sin respuesta (Pro) Muestra las preguntas que hicieron los visitantes y que la base de conocimientos no pudo responder. | Edición 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 tickets Muestra una lista de tickets de soporte, filtrados por estado o búsqueda, una página a la vez. | Edición 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 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 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 | 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 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 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 gratuita | POST …/abilities/zinn-chat/reply-chat/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/save-canned-replyzinn-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 Pro | POST …/abilities/zinn-chat/save-canned-reply/run | the REST route's own per-item permission check | id: integer, title: string (obligatorio), body: string (obligatorio), shortcut: string, department: string |
zinn-chat/save-kb-articlezinn-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 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 | Busca en la base de conocimiento (Pro) Encuentra artículos de ayuda para enlazar en una respuesta (q: la búsqueda). | Edición Pro | GET …/abilities/zinn-chat/search-kb/run | the REST route's own per-item permission check | q: string (obligatorio) |
zinn-chat/set-conversation-detailszinn-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 Pro | POST …/abilities/zinn-chat/set-conversation-details/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (obligatorio), department: string, tags: array |
zinn-chat/set-kb-gap-statuszinn-chat-set-kb-gap-status | Marcar preguntas sin responder (Pro) Marca las preguntas sin respuesta como abiertas, planificadas o descartadas (ids, status). | Edición Pro | POST …/abilities/zinn-chat/set-kb-gap-status/run | the REST route's own per-item permission check | ids: array (obligatorio), status: open|drafted|answered|ignored (obligatorio) |
zinn-chat/set-presencezinn-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 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 | 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 Pro | POST …/abilities/zinn-chat/suggest-reply/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (obligatorio) |
zinn-chat/summarise-conversationzinn-chat-summarise-conversation | Resume una conversación con IA (Pro) Resume un chat o ticket en unas pocas líneas. | Edición Pro | POST …/abilities/zinn-chat/summarise-conversation/run | the REST route's own per-item permission check | kind: ticket|chat, id: integer (obligatorio) |
zinn-chat/take-chatzinn-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 gratuita | POST …/abilities/zinn-chat/take-chat/run | the REST route's own per-item permission check | id: string (obligatorio) |
zinn-chat/update-settingszinn-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 gratuita | POST …/abilities/zinn-chat/update-settings/run | zinn_chat_manage | settings: object (obligatorio) |
zinn-chat/update-ticketzinn-chat-update-ticket | Cambiar un ticket Cambia el estado, la prioridad o el asignado de un ticket. | Edición gratuita | POST …/abilities/zinn-chat/update-ticket/run | the REST route's own per-item permission check | id: 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.
| Webhook | Clase | Qué hace | Parámetros | Edición |
|---|---|---|---|---|
zinn_chat_admin_pages | Filtrar | Filtra las pantallas de administración de Zinn® Chat (Pro añade las suyas propias). | Ninguno | Edición gratuita |
zinn_chat_agent_chat | Filtrar | Filtra el contenido del chat para la consola del agente (Pro añade detalles del visitante, notas y sugerencias de la base de conocimientos). | Ninguno | Edición gratuita |
zinn_chat_agent_pages | Filtrar | Filtra las pantallas de Zinn® Chat que puede abrir una cuenta de agente de soporte. | Ninguno | Edición Pro |
zinn_chat_agent_script_src | Filtrar | Filtra la URL desde la que se carga el agente de chat de IA independiente. | string $src | Edición gratuita |
zinn_chat_agent_ticket | Filtrar | Filtra la carga útil de los tickets para wp-admin (Pro añade respuestas predefinidas, SLA, sugerencias de base de conocimientos). | Ninguno | Edición gratuita |
zinn_chat_answer | Filtrar | Filtra la respuesta de un asistente antes de que se muestre (Pro añade sus extras aquí). | string $question | Edición gratuita |
zinn_chat_assistant_answered | Acción | El asistente respondió a un visitante. | int $id, string $text | Edición gratuita |
zinn_chat_challenge | Filtrar | Filtra 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 } )`). | Ninguno | Edición gratuita |
zinn_chat_challenge_ok | Filtrar | Filtra 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 $where | Edición gratuita |
zinn_chat_client_ip | Filtrar | Filtra la dirección IP del visitante utilizada para los límites de tasa y los registros. | string $ip | Edición gratuita |
zinn_chat_console_config | Filtrar | Filtra la configuración adicional proporcionada al script de la consola del operador; Zinn® Chat Pro añade sus características aquí. | Ninguno | Edición gratuita |
zinn_chat_conversation_started | Acción | Un visitante ha iniciado un chat. | int $id | Edición gratuita |
zinn_chat_conversation_status | Acción | Una conversación cambió de estado. | int $id, string $status, string $old | Edición gratuita |
zinn_chat_customer_ticket_url | Filtrar | Filtra el enlace que se le envía a un cliente para su ticket. | string $url | Edición gratuita |
zinn_chat_elements | Filtrar | Filtra los elementos del front-end ofrecidos como bloques y módulos del constructor. | Ninguno | Edición gratuita |
zinn_chat_email | Filtrar | Filtra un correo electrónico antes de ser enviado. Devuelve un `to` vacío para detenerlo. | Ninguno | Edición gratuita |
zinn_chat_fs_loaded | Acción | Se 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()`. | Ninguno | Edición gratuita |
zinn_chat_index_extract | Filtrar | Filtra un objeto extraído (o proporciona uno para un tipo de objeto personalizado). | string $type, int $id | Edición gratuita |
zinn_chat_index_language | Filtrar | Filtra el idioma (configuración regional) de una publicación indexada. | string $language, \WP_Post $post | Edición gratuita |
zinn_chat_index_object | Punto de entrada (se inicia) | Hooks | Ninguno | Edición gratuita |
zinn_chat_index_post_types | Filtrar | Filtra los tipos de publicaciones que lee el asistente. | Ninguno | Edición gratuita |
zinn_chat_indexable | Filtrar | Filtra si una publicación está indexada. | bool $indexable, \WP_Post $post | Edición gratuita |
zinn_chat_indexed | Acción | Se ha indexado (o reindexado) un objeto. | string $type, int $id | Edición gratuita |
zinn_chat_is_pro | Filtrar | Filtra 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 $pro | Edición gratuita |
zinn_chat_loaded | Acción | Zinn® Chat se ha cargado (el punto de extensión para complementos). | Ninguno | Edición gratuita |
zinn_chat_message_added | Acción | Se ha añadido un mensaje a una conversación. | int $id, int $conversation_id, string $role | Edición gratuita |
zinn_chat_order_tracking | Filtrar | Filtra la información de seguimiento proporcionada al asistente para un pedido. | \WC_Order $order | Edición gratuita |
zinn_chat_pro_alert | Acción | Ha ocurrido un evento digno de alerta (las notificaciones push se escuchan aquí). | string $alert, int $id, string $text, string $link | Edición Pro |
zinn_chat_pro_assigned | Acción | Se ha asignado un ticket a un agente automáticamente. | int $id, int $agent | Edición Pro |
zinn_chat_pro_loaded | Acción | Se ha cargado la capa Pro. | Ninguno | Edición Pro |
zinn_chat_pro_priority_changed | Acción | La prioridad de un ticket ha cambiado (los objetivos de SLA se ajustan a ella). | int $id | Edición Pro |
zinn_chat_pro_sla_breach | Acción | Se ha incumplido un objetivo de SLA. | int $ticket_id, string $which | Edición Pro |
zinn_chat_pro_ticket_rated | Acción | Un cliente calificó un ticket resuelto (1-5). | int $id, int $score | Edición Pro |
zinn_chat_rated | Acción | Se 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 $rating | Edición gratuita |
zinn_chat_role_capabilities | Filtrar | Filtra qué roles reciben qué capacidades de Zinn® Chat. | Ninguno | Edición gratuita |
zinn_chat_save_settings | Filtrar | Filtra la configuración antes de que se almacene (Pro añade sus propias claves aquí). | Ninguno | Edición gratuita |
zinn_chat_script_src | Filtrar | Filtra la URL desde la que se carga el widget de chat alojado (modo conectado). | string $src | Edición gratuita |
zinn_chat_settings_before | Acción | Salida sobre el formulario de una pestaña de configuración. | string $tab | Edición gratuita |
zinn_chat_settings_fields | Filtrar | Filtra los campos de una pestaña de configuración (Pro añade los suyos propios). | string $tab | Edición gratuita |
zinn_chat_settings_tabs | Filtrar | Filtra las pestañas de configuración. | Ninguno | Edición gratuita |
zinn_chat_setup_after | Acción | Resultado bajo la lista de comprobación de configuración (la edición gratuita muestra la tarjeta Pro aquí). | Ninguno | Edición gratuita |
zinn_chat_should_render | Filtrar | Filtra si el chat se muestra en esta solicitud (los ganchos de segmentación de páginas de Pro se conectan aquí). | bool $render | Edición gratuita |
zinn_chat_site_facts | Filtrar | Filtra 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 $language | Edición gratuita |
zinn_chat_site_strings | Filtrar | Filtra los textos del propietario ofrecidos para traducción (Pro añade sus mensajes proactivos). | Ninguno | Edición gratuita |
zinn_chat_system_prompt | Filtrar | Filtra el mensaje del sistema del asistente (Pro: reglas de personalidad y transferencia). | string $rules | Edición gratuita |
zinn_chat_team_online | Filtrar | Filtra si una persona puede responder ahora (Pro añade el horario comercial aquí). | bool $online | Edición gratuita |
zinn_chat_ticket_assigned | Acción | An agent assigned a ticket to an agent (2.14.0: the notification centre tells them). | int $id, int $assignee, int $by | Edición gratuita |
zinn_chat_ticket_created | Acción | Se ha abierto un ticket. El servicio de correo envía la confirmación y la alerta al equipo desde aquí. | int $id, string $token | Edición gratuita |
zinn_chat_ticket_form_extra | Filtrar | Filtra el marcado adicional al final de un formulario de ticket de invitado (la verificación humana de Pro va aquí). | string $html | Edición gratuita |
zinn_chat_ticket_form_fields | Filtrar | Filtra 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 $html | Edición gratuita |
zinn_chat_ticket_reply | Acción | Se 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 $author | Edición gratuita |
zinn_chat_ticket_status | Acción | Un ticket ha cambiado de estado. | int $id, string $status, string $old | Edición gratuita |
zinn_chat_uninstall | Acción | Zinn® Chat se está desinstalando (Pro elimina sus propios datos aquí). | Ninguno | Edición gratuita |
zinn_chat_widget_config | Filtrar | Filtra la configuración del lanzador impresa en la página. | Ninguno | Edición gratuita |
zinn_chat_widget_status | Filtrar | Filtra lo que recibe el chat abierto (Pro añade sus propios conmutadores y palabras). | Ninguno | Edición gratuita |