Listar, buscar y filtrar conversaciones

Endpoint unificado para obtener conversaciones. Funciona en dos modos que se
seleccionan de forma automática según los parámetros enviados.

Modo búsqueda

Se activa cuando se envía el parámetro query. Devuelve las conversaciones que
coinciden con el término buscado. El parámetro search_type define cómo se busca:

  • contactName (valor por defecto): busca por nombre del contacto o por
    número de teléfono. Ideal para encontrar la conversación de una persona.
  • all: busca por coincidencia dentro del contenido de los mensajes.
    Ideal para encontrar conversaciones donde se mencionó una palabra o frase.

Cuando se envía query, los parámetros de filtrado (status, phones, labels,
agents, dates, etc.) no se tienen en cuenta.

Modo filtros

Se usa cuando no se envía query. Devuelve el listado de conversaciones
aplicando los filtros indicados: estado, líneas de WhatsApp, etiquetas, agentes,
rango de fechas, entre otros. Si no se envía ningún filtro, se devuelven todas
las conversaciones.

Paginación por cursor

Ambos modos usan paginación por cursor, no por número de página. Cada
respuesta incluye un objeto pagination con:

  • next_cursor: cursor de la página siguiente.
  • prev_cursor: cursor de la página anterior.
  • has_more: true si existen más resultados después de la página actual.

Para avanzar o retroceder, reenvíe el valor de next_cursor o prev_cursor en el
parámetro cursor de la siguiente petición. El cursor es un valor opaco: no
debe interpretarse ni modificarse, solo reenviarse tal cual. La primera página se
solicita sin enviar cursor. Un cursor en null indica que no hay más
páginas en esa dirección.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≤ 100

Término de búsqueda. Al enviar este parámetro el endpoint entra en modo
búsqueda
y los filtros se ignoran. Longitud máxima: 100 caracteres.

string
enum
Defaults to contactName

Define cómo se realiza la búsqueda (solo aplica en modo búsqueda):

  • contactName: busca por nombre de contacto o por número de teléfono.
  • all: busca por coincidencia en el contenido de los mensajes.
    Valor por defecto: contactName.
Allowed:
string
enum

Filtra por estado de la conversación (modo filtros):

  • open: abiertas
  • hold: en espera
  • closed: cerradas
Allowed:
string

IDs de las líneas de WhatsApp por las que filtrar, separados por coma.
Los IDs se obtienen en el endpoint /whatsapp-numbers.

string

IDs de etiquetas por las que filtrar, separados por coma.

string

IDs de agentes por los que filtrar, separados por coma.

string

Rango de fechas (modo filtros). Dos fechas en formato YYYY-MM-DD
separadas por coma: fecha_inicio,fecha_fin.

boolean

Si es true, devuelve solo las conversaciones que no tienen ninguna etiqueta.

string
enum

Filtro adicional sobre la conversación (modo filtros):

  • 0: sin filtro adicional
  • 1: solo conversaciones con mensajes sin leer
  • 2: conversaciones dentro de la ventana de 24 horas (sesión activa)
  • 3: conversaciones fuera de la ventana de 24 horas (sesión expirada)
Allowed:
string
enum
Defaults to 0

Orden del listado por fecha (modo filtros):

  • 0: más recientes primero (descendente)
  • 1: más antiguas primero (ascendente)
    Valor por defecto: 0 (descendente).
Allowed:
boolean

Si es true, incluye las conversaciones de todos los agentes
(requiere permiso de modo supervisor). Por defecto solo se devuelven
las conversaciones del agente autenticado.

string

Cursor de paginación. Para la primera página no se envía. Para avanzar
o retroceder, reenvíe el valor next_cursor o prev_cursor recibido en la
respuesta anterior. Es un valor opaco: no debe interpretarse ni modificarse.

integer
1 to 50
Defaults to 20

Cantidad de conversaciones por página. Mínimo 1, máximo 50.
Valor por defecto: 20.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json