Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-08-0610636149.4 KB
Conversations

Listar conversaciones

Conversaciones de la empresa autenticada, con filtros avanzados y paginación.

get/v1/conversations

Query parameters

status'opened' | 'closed' | 'inactive'

Estado de la conversación

tagsstring
Example:urgente,vip

Filtrar por tags. Uno o varios valores en un único parámetro, separados por coma (ej. ?tags=urgente,vip), no como parámetros repetidos.

fromDatestring date-time

Fecha de inicio (ISO 8601)

toDatestring date-time

Fecha de fin (ISO 8601)

channelstring
Example:WEB,WHATSAPP

Filtrar por canal. Uno o varios valores (WEB, WHATSAPP, FACEBOOK, INSTAGRAM) en un único parámetro, separados por coma (ej. ?channel=WEB,WHATSAPP), no como parámetros repetidos.

phasestring

ID de la fase (etapa de inbox)

agentstring

ID del agente que intervino la conversación (último operador que envió un mensaje). Devuelve las conversaciones intervenidas por ese agente. Usá robot para traer solo las atendidas por el bot (sin intervención humana).

preAssignedstring

ID del agente asignado (pre-asignación automática). Devuelve las conversaciones asignadas a ese agente.

conditionstring
Example:intervened,lead

Filtra por estado de intervención. Uno o varios valores en un único parámetro, separados por coma (ej. ?condition=intervened,lead): intervened (intervenidas por un humano), not_intervened (atendidas solo por el bot), lead (marcadas como lead).

utmSourcestring

Filtrar por fuente de campaña (UTM source). Ej. google, facebook.

utmMediumstring

Filtrar por medio de campaña (UTM medium). Ej. cpc, organic.

utmCampaignstring

Filtrar por nombre de campaña (UTM campaign).

searchstring

Búsqueda de texto libre

limitinteger

Resultados por página

offsetinteger

Offset de paginación

pageinteger

Número de página

sortstring

Campo y orden de ordenamiento (ej: createdAt:desc)

Response

Lista de conversaciones

dataobject

Mapa de conversaciones indexado por el id de cada conversación (la clave es el conversationId y el valor es el objeto Conversation).

Example response

{
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "totalPages": 3,
    "hasNext": true
  },
  "data": {
    "626e9cc66ac98128162b2bbc": {
      "id": "626e9cc66ac98128162b2bbc",
      "channel": "WHATSAPP",
      "status": "ACTIVE"
    }
  }
}