Buscar empresas en Freshdesk, con una API
Encuentra empresas por nombre y devuelve el id y el name de cada una, el company_id que usan tickets y contactos.
- Identificador
- freshdesk_search_companies
La llamada
POST https://connect.reportei.com/api/tools/freshdesk_search_companies/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"name": "<name>"
}
}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 |
|---|---|---|---|
| name | string | Sí | Start of a word of the company name, case insensitive. Acme Corporation matches acme or corp, not cme. |
Conexiones posibles
Tu cliente conecta su cuenta de Freshdesk una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Usuario y contraseña
Tu cliente ingresa las credenciales de la app en una pantalla de Connect, o tu sistema las envía con POST /api/customer-toolkits, sin pantalla.
Al conectar, tu cliente también indica {domain}: la dirección de su cuenta en la API de la app.
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/freshdesk_search_companies. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Freshdesk
- Listar ticketsGETLista tickets, los más recientes primero por defecto. Sin updated_since solo vuelven los tickets creados en los últimos 30 días, y spam o eliminados solo vienen con filtro.
- Buscar ticketsGETBusca tickets con una query de filtro, por ejemplo por estado, prioridad, agente, grupo, etiqueta o campo personalizado. Devuelve total y results, 30 tickets por página.
- Obtener ticketGETDevuelve un ticket con status, priority, requester_id, responder_id, group_id, tags, custom_fields y description.
- Crear ticketPOSTCrea un ticket. Identifica al solicitante con requester_id, email, phone o unique_external_id; un email o phone que aún no existe en Freshdesk crea el contacto.
- Actualizar ticketPUTActualiza un ticket: envía solo los campos a cambiar, y tags como la lista completa que el ticket debe conservar. Status 4 lo resuelve y 5 lo cierra.
- Listar conversaciones del ticketGETLista las respuestas y notas de un ticket, con body (HTML), body_text, private, incoming, user_id y source (0 respuesta, 2 nota). Las páginas se numeran desde 1.
- Crear respuesta en el ticketPOSTResponde al solicitante de un ticket. Freshdesk envía la respuesta por correo al solicitante, así que es visible para el cliente.
- Crear nota en el ticketPOSTAgrega una nota a un ticket. Las notas son privadas por defecto, visibles solo para los agentes; con private en false el solicitante también la ve.
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.
