Obtener una Conversación

Obtiene el estado actual y el historial de mensajes de una conversación específica.

GET https://api.platica.mx/v1/conversations/{conversationId}

Parámetros de consulta

Parámetro	Tipo	Descripción	Requerido
`channelId`	string	Filtra la búsqueda por canal cuando hay múltiples conversaciones con el mismo `conversationId`	—

Parámetros de URL

Parámetro	Tipo	Descripción	Requerido
`conversationId`	string	Identificador único de la conversación	✓

Respuesta

{
  "workspaces": [
    {
      "id": "ws_001",
      "name": "Soporte General",
      "conversationsCount": 1,
      "conversations": [
        {
          "id": "conv_001",
          "conversationId": "987654321098",
          "canSendDirectMessage": true,
          "workspaceId": "ws_001",
          "channelId": "channel_001",
          "contactName": "Juan Pérez",
          "phoneNumber": "1234567890",
          "topic": "Consulta General",
          "platform": "whatsapp",
          "owners": [
            "soporte@empresa.com"
          ],
          "tags": [
            "prioridad-alta"
          ],
          "creationDate": "2025-03-15T10:00:00Z",
          "lastUpdate": "2025-03-15T10:15:00Z",
          "status": "active",
          "operation": "assistance",
          "messageCount": 4,
          "messages": [
            {
              "content": "Hola, necesito información sobre sus servicios.",
              "contentType": "text",
              "creationDate": "2025-03-15T09:58:00Z",
              "direction": "incoming",
              "files": [],
              "id": "msg_001",
              "images": [],
              "owner": {
                "id": "user_001"
              },
              "lastUpdate": "2025-03-15T09:58:00Z",
              "role": "user",
              "status": "received"
            },
            {
              "content": "Hola, ¿cómo puedo ayudarte hoy?",
              "contentType": "text",
              "creationDate": "2025-03-15T10:00:00Z",
              "direction": "outgoing",
              "files": [],
              "id": "msg_002",
              "images": [],
              "owner": {
                "id": "agent_001"
              },
              "lastUpdate": "2025-03-15T10:00:00Z",
              "role": "assistant",
              "status": "delivered"
            },
            {
              "content": "Tengo una duda sobre el producto que compré.",
              "contentType": "text",
              "creationDate": "2025-03-15T10:05:00Z",
              "direction": "incoming",
              "files": [],
              "id": "msg_003",
              "images": [],
              "owner": {
                "id": "user_001"
              },
              "lastUpdate": "2025-03-15T10:05:00Z",
              "role": "user",
              "status": "received"
            },
            {
              "content": "Gracias por tu consulta. Te ayudaré con eso.",
              "contentType": "text",
              "creationDate": "2025-03-15T10:10:00Z",
              "direction": "outgoing",
              "files": [],
              "id": "msg_004",
              "images": [],
              "owner": {
                "id": "agent_001"
              },
              "lastUpdate": "2025-03-15T10:10:00Z",
              "role": "assistant",
              "status": "delivered"
            }
          ]
        }
      ]
    }
  ]
}

Campo	Descripción
`id`	ID interno de la conversación
`conversationId`	ID público de la conversación (Hash o teléfono del cliente)
`canSendDirectMessage`	Indica si se pueden enviar mensajes directos (ventana de 24h activa)
`workspaceId`	ID del workspace al que pertenece la conversación
`channelId`	ID del canal de comunicación
`contactName`	Nombre del contacto/cliente
`phoneNumber`	Número de teléfono del cliente
`topic`	Tema o asunto de la conversación
`platform`	Plataforma de mensajería (`whatsapp`, `telegram`, etc.)
`owners`	Lista de correos de usuarios responsables
`tags`	Etiquetas asociadas a la conversación
`status`	Estado de la conversación. Actualmente puede ser `active`, `finished`, `spam` o `expired`
`operation`	Modo de operación de la conversación
`messageCount`	Número total de mensajes en la conversación
`messages`	Lista de mensajes de la conversación
`creationDate`	Fecha de creación en formato ISO 8601
`lastUpdate`	Fecha de última actualización en formato ISO 8601

Campo	Descripción
`id`	Identificador único del mensaje
`content`	Contenido del mensaje
`contentType`	Tipo de contenido: `text`, `image`, `audio`, etc.
`creationDate`	Fecha y hora de creación del mensaje
`direction`	Dirección del mensaje: `incoming` (entrante) o `outgoing` (saliente)
`files`	Lista de archivos asociados al mensaje
`images`	Lista de imágenes asociadas al mensaje
`lastUpdate`	Fecha de última actualización del mensaje
`owner`	Objeto con información mínima del emisor. Actualmente incluye `id` cuando existe
`role`	Rol del emisor: `user` (cliente) o `assistant` (agente/IA)
`status`	Estado del mensaje: `received`, `delivered`, `read`, `failed`

Consejo

Si necesitas cambiar owners o status, utiliza el endpoint de actualizar conversación .

Anterior Introducción Siguiente Listar Conversaciones