Export conversations

Export conversations. See the OpenAPI-defined parameters, request body, and responses below.

OpenAPI description: Este endpoint retorna todas as conversas que atendem ao filtro informado, com itens de checklist opcionais.

Authentication

Authentication required. Send your user API key in the X-API-Key header.

Parameters

This operation has no path, query, or header parameters.

Request body

Content type: application/json · Schema: ConversationExportFilterDto

Example request

curl --request POST \
  --url 'https://api.zild.ai/Conversation/export' \
  --header 'X-API-Key: YOUR_USER_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "enableFilter": 0,
  "liveAgentFilter": 0,
  "callSuccessfulFilter": 0,
  "messageContent": "string",
  "userIds": [
    0
  ],
  "botIds": [
    0
  ],
  "tagIds": [
    0
  ],
  "from": "string",
  "createdAtStart": "2026-09-22T18:00:00Z",
  "createdAtEnd": "2026-09-22T18:00:00Z",
  "finishedAt": "2026-09-22T18:00:00Z",
  "conversationFilterQueue": 0,
  "integrationType": 0,
  "conversationEvaluationStatus": 0,
  "queueIds": [
    0
  ],
  "conversationType": 0,
  "userId": 0,
  "botId": 0,
  "tagId": 0,
  "id": 0,
  "title": "string",
  "finalScoreFrom": 0,
  "finalScoreTo": 0,
  "includeChecklistItemConversations": true
}'

Responses

Example response (200):

[
  {
    "conversation": {
      "id": 0,
      "active": true,
      "title": "string",
      "liveAgent": true,
      "from": "string",
      "conversationId": "string",
      "waterMark": "string",
      "token": "string",
      "createdAt": "2026-09-22T18:00:00Z",
      "finishedAt": "2026-09-22T18:00:00Z",
      "queuedAt": "2026-09-22T18:00:00Z",
      "lastConversationUpdateTime": "2026-09-22T18:00:00Z",
      "lastMessageContent": "string",
      "contactId": 0,
      "contactName": "string",
      "userId": 0,
      "userName": "string",
      "counterpartUserId": 0,
      "counterpartUserName": "string",
      "botId": 0,
      "botName": "string",
      "fileUrl": "string",
      "fileName": "string",
      "tenantId": 0,
      "conversationSummary": "string",
      "messages": [
        {
          "id": 0,
          "createdAt": "2026-09-22T18:00:00Z",
          "from": "string",
          "to": "string",
          "content": "string",
          "conversationId": 0,
          "sentiment": "string",
          "offset": "string",
          "isNPS": true,
          "contentSid": "string",
          "messageType": 0,
          "conversationTemplateId": 0,
          "mediaUrl": "string",
          "mediaFileName": "string",
          "tenantId": 0,
          "userId": 0,
          "contentVariables": "string",
          "messageSid": "string",
          "messageStatus": 0,
          "sent": true,
          "delivered": true,
          "read": true,
          "errorCode": "string",
          "errorMessage": "string",
          "isReadByUser": true,
          "documentId": 0
        }
      ],
      "score": 0,
      "finalScore": 0,
      "checklistId": 0,
      "communicationChannel": 0,
      "conversationIntegrationType": 0,
      "duration": "string",
      "highImportanceErrorDetected": true,
      "tags": [
        {
          "id": 0,
          "name": "string",
          "active": true,
          "createdAt": "2026-09-22T18:00:00Z",
          "tenantId": 0
        }
      ],
      "conversationEvaluationStatus": 0,
      "conversationEvaluationStatusMessage": "string",
      "queueId": 0,
      "queueName": "string",
      "conversationEndedReasonId": 0,
      "agentType": 0,
      "conversationType": 0,
      "applicationStatusId": 0,
      "overallSentiment": "string",
      "callStatus": "string",
      "disconnectionReason": "string",
      "callSuccessful": true,
      "totalUnreadedMessagesByUser": 0,
      "dynamicVariables": [
        {
          "id": 0,
          "name": "string",
          "value": "string",
          "conversationId": 0
        }
      ],
      "dataCollection": [
        {
          "id": 0,
          "name": "string",
          "value": "string",
          "conversationId": 0
        }
      ],
      "agentId": 0,
      "loadingResponse": true
    },
    "checklistItemConversations": [
      {
        "id": 0,
        "checklistItemId": 0,
        "checklistItemName": "string",
        "approved": true,
        "feedback": "string",
        "score": 0,
        "notApplicable": true,
        "checklistEvaluationId": 0,
        "conversationId": 0,
        "tenantId": 0,
        "highImportance": true,
        "maxScore": 0,
        "groupName": "string",
        "groupId": 0
      }
    ]
  }
]

Data models