Buscar conversaciones en Front, con una API

Busca las conversaciones a las que llega el token de API, de la actividad más reciente a la más antigua, y devuelve _total con las coincidencias. Las conversaciones en la papelera quedan fuera, salvo que la consulta pida is:trashed. La página siguiente viene del page_token dentro de _pagination.next, que es null en la última página.

Identificador
front_search_conversations

La llamada

POST https://connect.reportei.com/api/tools/front_search_conversations/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "query": "<query>"
  }
}

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
querystringSíWords and filters separated by spaces, combined with AND. Words match subject and body; quote a phrase. Filters: is:open, is:archived, is:assigned, is:unassigned, is:snoozed, is:unreplied, is:waiting, is:resolved, is:trashed; inbox:ID (List inboxes); tag:ID (List tags); assignee:ID or participant:ID (List teammates); from:, to:, cc: or recipient: with an email or handle; before:, after: or during: with a Unix time in seconds. Up to 15 filters.
limitintegerNoResults per page, up to 100. Defaults to 50.
page_tokenstringNoThe page_token value in the _pagination.next URL of the previous response.

Conexiones posibles

Tu cliente conecta su cuenta de Front 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/front_search_conversations. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Front

Ver las 13 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.