Get a Conversation

Returns the current state and message history of a specific conversation.

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

Query parameters

ParameterTypeDescriptionRequired
channelIdstringNarrows the lookup by channel when multiple conversations share the same conversationId

URL parameters

ParameterTypeDescriptionRequired
conversationIdstringUnique identifier of the conversation

Response

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}
FieldDescription
idInternal conversation ID
conversationIdPublic conversation ID (hash or customer phone number)
canSendDirectMessageIndicates whether direct messages can be sent (24-hour window active)
workspaceIdID of the workspace the conversation belongs to
channelIdCommunication channel ID
contactNameContact/customer name
phoneNumberCustomer phone number
topicConversation topic or subject
platformMessaging platform (whatsapp, telegram, etc.)
ownersList of responsible-user emails
tagsTags associated with the conversation
statusConversation status. Can currently be active, finished, spam, or expired
operationConversation operation mode
messageCountTotal number of messages in the conversation
messagesList of messages in the conversation
creationDateCreation date in ISO 8601 format
lastUpdateLast update date in ISO 8601 format
FieldDescription
idUnique identifier of the message
contentMessage content
contentTypeContent type: text, image, audio, etc.
creationDateMessage creation date and time
directionDirection of the message: incoming or outgoing
filesList of files attached to the message
imagesList of images attached to the message
lastUpdateDate the message was last updated
ownerObject with minimal sender information. Currently includes id when available
roleSender role: user (customer) or assistant (agent/AI)
statusMessage status: received, delivered, read, failed