Listar personas en Crisp, con una API
Lista o busca los contactos (perfiles de personas) de un workspace, con people_id, email, name, company, segments y notepad. Las páginas empiezan en 1, y una página con menos elementos que per_page es la última.
- Identificador
- crisp_list_people
La llamada
POST https://connect.reportei.com/api/tools/crisp_list_people/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"website_id": "<website_id>",
"page_number": 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 |
|---|---|---|---|
| website_id | string | Sí | Id of the workspace, from List websites. |
| page_number | integer | Sí | Page number, starting at 1. |
| per_page | integer | No | Contacts per page, from 20 to 50. Defaults to 20. |
| search_text | string | No | Quick search text, like a name or an email. |
| sort_field | string | No | Field to sort on, like nickname. |
| sort_order | string | No | Sort order.Valores: ascending, descending |
| filter_date_start | string | No | Only contacts created from this moment on, in ISO 8601. |
| filter_date_end | string | No | Only contacts created up to this moment, in ISO 8601. |
Conexiones posibles
Tu cliente conecta su cuenta de Crisp 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.
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/crisp_list_people. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Crisp
- Listar websitesGETLista los workspaces de Crisp, llamados websites en la API, donde está instalado el plugin de este token, con su website_id. Obtener website da el nombre de cada uno. Las páginas empiezan en 1, y una lista data vacía indica que no hay más páginas.
- Obtener websiteGETDevuelve el nombre, el dominio y el logo de un workspace de Crisp, para distinguir los ids que devuelve Listar websites.
- Listar conversacionesGETLista las conversaciones de un workspace, con session_id, state, contadores de no leídos, operador asignado, último mensaje y el meta del visitante (nickname, email, phone, segments). Las páginas empiezan en 1, y una página con menos elementos que per_page es la última.
- Obtener conversaciónGETDevuelve una conversación con su estado, operador asignado, contadores de no leídos, último mensaje, people_id del contacto y el meta del visitante. Los mensajes vienen de Listar mensajes de la conversación.
- Listar mensajes de la conversaciónGETDevuelve el último lote de mensajes de una conversación, con type, sender, content y timestamp en milisegundos. Para paginar hacia los mensajes más antiguos, envía el timestamp del mensaje más antiguo del lote como timestamp_before.
- Enviar mensajePOSTEnvía un mensaje como operador en una conversación. El type text llega al visitante de inmediato; el type note es una nota interna que solo ven los operadores.
- Actualizar estado de la conversaciónPATCHCambia el estado de una conversación a pending, unresolved o resolved.
- Asignar conversaciónPATCHAsigna una conversación a un operador, que recibe una notificación salvo que silent sea true.
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.
