Endpoint
Parámetros de consulta
integer
predeterminado:"20"
Cantidad máxima de conversaciones que se devuelven por página. Acepta valores entre
1 y 100.string
Cursor de paginación opaco, tomado del campo
pagination.next_cursor de la respuesta anterior. Si se omite, la lectura empieza por la primera página.string
Limita las conversaciones a un lead determinado. Se pasa un ID de lead como
lead_abc123 para recuperar todos los hilos de conversación de ese contacto.string
Filtra por el canal en el que transcurre la conversación. Valores aceptados:
whatsapp, facebook, instagram, email, phone.string
Filtra por estado de la conversación. Valores aceptados:
open, closed, transferred.Solicitud de ejemplo
cURL
Respuesta
Una solicitud correcta devuelve200 OK con un arreglo data de objetos de conversación y un objeto pagination.
Example response
Campos de la respuesta
array
Arreglo de objetos de conversación que coinciden con los filtros aplicados.
string
Identificador único de la conversación, con el prefijo
conv_.string
ID del lead al que pertenece la conversación.
string
Canal en el que transcurre la conversación. Uno de
whatsapp, facebook, instagram, email, phone.string
Estado actual de la conversación. Uno de:
open— conversación activa, con un agente de IA o una persona interviniendoclosed— conversación finalizada, no se esperan más mensajestransferred— derivada del agente de IA a un asesor de ventas humano
string
Marca de tiempo ISO 8601 del momento en que se abrió la conversación.
string
Marca de tiempo ISO 8601 del cambio más reciente en el registro de la conversación.
string
Marca de tiempo ISO 8601 del mensaje o evento más reciente de esta conversación.
integer
Cantidad total de conversaciones que coinciden con los filtros aplicados.
boolean
true si existen páginas adicionales.string | null
Este valor se pasa como
cursor para obtener la página siguiente. Es null cuando has_more es false.