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 URL

ParámetroTipoDescripciónRequerido
conversationIdstringIdentificador único de la conversación

Respuesta

{
  "workspaces": [
    {
      "id": "ws_001",
      "name": "Soporte General",
      "count": 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",
          "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",
              "id": "msg_001",
              "owner": {
                "id": "user_001",
                "name": "Juan Pérez"
              },
              "role": "user",
              "status": "received"
            },
            {
              "content": "Hola, ¿cómo puedo ayudarte hoy?",
              "contentType": "text",
              "creationDate": "2025-03-15T10:00:00Z",
              "direction": "outgoing",
              "id": "msg_002",
              "owner": {
                "id": "agent_001",
                "name": "Carlos López"
              },
              "role": "assistant",
              "status": "delivered"
            },
            {
              "content": "Tengo una duda sobre el producto que compré.",
              "contentType": "text",
              "creationDate": "2025-03-15T10:05:00Z",
              "direction": "incoming",
              "id": "msg_003",
              "owner": {
                "id": "user_001",
                "name": "Juan Pérez"
              },
              "role": "user",
              "status": "received"
            },
            {
              "content": "Gracias por tu consulta. Te ayudaré con eso.",
              "contentType": "text",
              "creationDate": "2025-03-15T10:10:00Z",
              "direction": "outgoing",
              "id": "msg_004",
              "owner": {
                "id": "agent_001",
                "name": "Carlos López"
              },
              "role": "assistant",
              "status": "delivered"
            }
          ]
        }
      ]
    }
  ]
}
CampoDescripción
idID interno de la conversación
conversationIdID público de la conversación (Hash o teléfono del cliente)
canSendDirectMessageIndica si se pueden enviar mensajes directos (ventana de 24h activa)
workspaceIdID del workspace al que pertenece la conversación
channelIdID del canal de comunicación
contactNameNombre del contacto/cliente
phoneNumberNúmero de teléfono del cliente
topicTema o asunto de la conversación
platformPlataforma de mensajería (whatsapp, telegram, etc.)
statusEstado de la conversación: active, closed, pending
operationModo de operación: automatic (IA) o assistance (humano)
messageCountNúmero total de mensajes en la conversación
messagesLista de mensajes de la conversación
CampoDescripción
idIdentificador único del mensaje
contentContenido del mensaje
contentTypeTipo de contenido: text, image, audio, etc.
creationDateFecha y hora de creación del mensaje
directionDirección del mensaje: incoming (entrante) o outgoing (saliente)
ownerObjeto con información del emisor (id, name)
roleRol del emisor: user (cliente) o assistant (agente/IA)
statusEstado del mensaje: received, delivered, read, failed