Get conversations for a ticket

`GET /ticket/{ticketId}/conversation`

Retrieve all conversations associated with a specific ticket

Path parameters

ticketIdintegerpathrequired

The ID of the ticket to get conversations for

Query parameters

includeRawDatabooleanquery

Whether to include raw data in the response

typeanyquery

Filter by conversation type (e.g. neo, text, html, note). Accepts a single value or an array. When absent, all types are returned.

directionanyquery

Filter by conversation direction. Accepts a single value or an array. When absent, all directions are returned.

privatebooleanquery

Filter by private flag. When absent, both private and public conversations are returned.

senderIdanyquery

Filter by sender.id (the human operator/customer). Accepts a single value or an array.

toIdanyquery

Filter by the id of any entry in the to array (participant id; email/string entries carry no id and never match). Accepts a single value or an array.

Responses

200 — Successful operation

Response Example

{
  "conversations": [
    {
      "id": 123,
      "ticketId": 123,
      "type": "html",
      "direction": "out",
      "private": false,
      "isDraft": false,
      "fromEmail": "service@enneo.ai",
      "fromEmailName": "Enneo Admin",
      "agentId": 1,
      "sender": {
        "id": 1,
        "name": "Enneo Admin",
        "email": "example@enneo.ai",
        "subchannelId": 1
      },
      "toEmail": [
        "to@gmail.com"
      ],
      "to": [
        "service@enneo.ai"
      ],
      "ccEmails": [
        "cc@gmail.com"
      ],
      "bccEmails": [
        "bcc@gmail.com"
      ],
      "channelId": "msg-123-abc",
      "content": {
        "message": "Thank you for your message, we can inform you that..."
      },
      "intentIds": [
        "ai_agent_meter_reading"
      ],
      "cortexRequestId": 123,
      "externalConversationId": "abc-123",
      "isRead": false,
      "attachments": [
        {
          "id": "103013960646,",
          "url": "https://storage.googleapis.com/enneo-attachments-public/a1/103013960646-4b1aa775/IMG_20230301_192712.jpg",
          "name": "IMG_20230301_192712.jpg",
          "size": 2292952,
          "width": 3120,
          "height": 4160,
          "inline": false,
          "fileEnding": "jpg",
          "contentType": "image/jpeg",
          "originalUrl": "https://storage.example.com/attachments/IMG_20230301_192712.jpg",
          "extractedData": null,
          "extractionStatus": "success",
          "extractionData": {
            "confidence": 0.815,
            "meterValue": 87870.5
          }
        }
      ],
      "interface": [],
      "createdAt": 1657056276,
      "modifiedAt": 1672756198
    }
  ],
  "success": true
}

403 — Unauthorized

404 — Ticket not found

500 — Internal error