Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Conversaciones

Listar conversaciones

Usalo para construir tu propia bandeja de entrada o sincronizar conversaciones: filtrá por número, asesor, etiquetas, etapa del kanban, no leídas o lead score, y traé solo lo nuevo con updated_since.

GET
/conversations

Permiso requerido: conversations:read

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de consulta

favorites?boolean
ownContacts?boolean
ownAndUnassigned?boolean
perName?string
deviceId?integer
contactId?integer
advisorId?integer
advisorIds?string
activeConversation?boolean
tags?string
kanbanSettingId?integer
Rango1 <= value
kanbanStageIds?string
unreadMessages?boolean
onlyWithMac?boolean
cursor?string
updated_since?string
paused?string
Valor en"true""false""1""0"
leadScoreCategories?string|null
leadScoreMin?integer
Rango0 <= value <= 100
leadScoreMax?integer
Rango0 <= value <= 100
leadScoreDisqualified?|
Valor en"include""exclude""only"null
metaWindowOpen?boolean
metaWindowDeviceIds?string|null
lastMessageDateFrom?|
Formatodate
lastMessageDateTo?|
Formatodate
timezone?string|null
customFieldFilters?string|null
perPage?integer
Rango1 <= value <= 100
Por defecto25
orderBy?string
Valor en"asc""desc"

Cuerpo de la respuesta

OK

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/conversations"
{  "data": [    {      "is_mac_inactive": true    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "path": "string",    "per_page": 0,    "next_cursor": "string",    "prev_cursor": "string"  }}

Conversaciones

Una conversación es el chat de WhatsApp entre tu negocio y un contacto: puede estar activa o no (active_conversation), asignada a un asesor, marcada como favorita o sin leer, y la atiende uno de tus números.

Contar conversaciones sin leer GET

Sirve para mostrar un contador de conversaciones sin leer, por ejemplo en un badge o tablero, filtrable por asesores o favoritas.