Conversaciones

Interacciones de mensajeria WhatsApp y chat. Consulta el historial de conversaciones, mensajes y metadatos de tus canales de comunicacion.

Endpoints

Metodo	Endpoint	Descripcion	Scope
GET	/conversations	Listar conversaciones con filtros	conversations:read
GET	/conversations/{id}	Obtener una conversacion por ID	conversations:read
GET	/conversations/{id}/messages	Obtener todos los mensajes de una conversacion	conversations:read

Enmascaramiento de PII

El endpoint GET /conversations/{id}/messages soporta el header X-Exclude-PII: true para enmascarar automaticamente numeros de telefono y otra informacion de identificacion personal en la respuesta.

Parametros de Consulta

Filtros disponibles para GET /conversations

Parametro	Tipo	Descripcion
channelId	string	Filtrar por ID de canal
campaignId	string	Filtrar por ID de campana
status	string	Filtrar por estado de la conversacion
dateFrom	ISO 8601	Fecha de inicio para filtro de rango de fechas
dateTo	ISO 8601	Fecha de fin para filtro de rango de fechas
page	integer	Numero de pagina (por defecto: 1)
pageSize	integer	Elementos por pagina (por defecto: 25, maximo: 100)

Ejemplos de Solicitudes

Listar conversaciones de un canal:

curl https://api.auralytik.com/v1/conversations?channelId=ch_whatsapp&page=1&pageSize=10 \
  -H "Authorization: Bearer YOUR_API_KEY"

Obtener mensajes con enmascaramiento de PII:

curl https://api.auralytik.com/v1/conversations/conv_123/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Exclude-PII: true"

Ejemplo de Respuesta

{
  "data": [
    {
      "id": "conv_123",
      "channelId": "ch_whatsapp",
      "campaignId": "camp_456",
      "status": "completed",
      "participantCount": 2,
      "messageCount": 14,
      "startedAt": "2024-01-15T10:30:00Z",
      "endedAt": "2024-01-15T10:45:22Z",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ],
  "page": 1,
  "pageSize": 10,
  "totalCount": 523
}

Respuesta de Mensajes

Con X-Exclude-PII: true:

{
  "conversationId": "conv_123",
  "messages": [
    {
      "id": "msg_001",
      "role": "customer",
      "content": "Hi, I need help with my account ending in ****",
      "timestamp": "2024-01-15T10:30:00Z"
    },
    {
      "id": "msg_002",
      "role": "agent",
      "content": "Of course! I'd be happy to help. Let me look that up.",
      "timestamp": "2024-01-15T10:30:15Z"
    }
  ]
}

Mas funciones de conversaciones proximamente

APIs de streaming de conversaciones en tiempo real, busqueda de mensajes y etiquetado de conversaciones estan en desarrollo.

Solicitar Acceso API