Buscar contactos en Chatwoot, con una API

Busca 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.

Identificador
chatwoot_search_contacts

La llamada

POST https://connect.reportei.com/api/tools/chatwoot_search_contacts/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ámetroTipoObligatorioDescripción
account_idintegerSí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.
qstringNoText matched against the name, identifier, email or phone number of the contact.
sortstringNoSort field; a leading minus sorts in descending order.Valores: name, email, phone_number, last_activity_at, -name, -email, -phone_number, -last_activity_at
pageintegerNoPage number, starting at 1.

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_search_contacts. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Chatwoot

Ver las 15 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.