Listar agentes en Chatwoot, con una API
Lista los agentes de la cuenta con id, nombre, email, rol y availability_status. El id es el assignee_id de una conversación.
- Identificador
- chatwoot_list_agents
La llamada
POST https://connect.reportei.com/api/tools/chatwoot_list_agents/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"account_id": 1
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| account_id | integer | Sí | Id of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123. |
Conexiones posibles
Tu cliente conecta su cuenta de Chatwoot una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/chatwoot_list_agents. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Chatwoot
- Listar conversacionesGETLista las conversaciones de una cuenta, por defecto las abiertas, con estado, etiquetas, inbox_id, can_reply, el contacto en meta.sender, el responsable y el último mensaje. data.meta trae los conteos por tipo de responsable. Las páginas empiezan en 1; un payload vacío significa que no hay más páginas.
- Crear conversaciónPOSTInicia una conversación con un contacto en una bandeja, opcionalmente con un primer mensaje. source_id identifica al contacto en esa bandeja: viene de contact_inboxes en Search contacts, de Create contact o de Create contact inbox. En bandejas de WhatsApp, el primer mensaje va como plantilla aprobada en message.template_params.
- Actualizar estado de la conversaciónPOSTDefine el estado de una conversación: open, resolved, pending o snoozed. Sin snoozed_until, una conversación en snoozed espera la próxima respuesta del contacto, y cualquier respuesta del contacto la reabre.
- Asignar conversaciónPOSTAsigna una conversación a un agente o a un equipo. Cuando se envía assignee_id, team_id se ignora.
- Actualizar etiquetas de la conversaciónPOSTDefine las etiquetas de una conversación. La lista enviada reemplaza las etiquetas actuales, así que debe incluir las que se quieren conservar.
- Listar mensajesGETDevuelve los últimos mensajes de una conversación en orden ascendente, con meta que contiene etiquetas, contacto y responsable. sender_type indica quién envió cada mensaje, y private marca las notas internas. Para mensajes más antiguos, pasa before con el id del más antiguo recibido.
- Crear mensajePOSTEnvía un mensaje en una conversación. Un mensaje saliente llega al contacto por el canal de la bandeja, como WhatsApp, email o el widget del sitio; private true crea una nota interna que solo ven los agentes. En WhatsApp, template_params envía una plantilla aprobada.
- Buscar contactosGETBusca los contactos que tienen identificador, email o teléfono, por nombre, identificador, email o número de teléfono, 15 por página. Cada contacto trae contact_inboxes, que une cada bandeja con el source_id que necesita Create conversation. meta.count es el total; una página con menos de 15 contactos es la última.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
