Consultar conversa

Este endpoint retorna os detalhes de uma conversa especificada pelo identificador.

GET /Conversation/{id}

Este endpoint retorna os detalhes de uma conversa especificada pelo identificador.

Autenticação

Autenticação obrigatória. Envie sua chave de API de usuário no header X-API-Key.

Parâmetros

Nome	Local	Tipo	Obrigatório	Descrição	Restrições
`id`	`path`	`integer · int32`	Sim	—	—

Corpo da requisição

Esta operação não recebe corpo de requisição.

Exemplo de requisição

curl --request GET \
  --url 'https://api.zild.ai/Conversation/{id}' \
  --header 'X-API-Key: YOUR_USER_API_KEY'

Respostas

Status	Descrição	Corpo da resposta
`200`	Sucesso ao retornar a conversa	`application/json` · `ConversationDto`

Exemplo de resposta (200):

{
  "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
}

Modelos de dados

AgentType

0 = ZildAssist; 1 = ZildFlow; 2 = ZildInsightChat; 3 = ZildChat; 4 = ZildDocs; 5 = ZildVoice; 6 = ZildCoach; 7 = ZildInsightChecklist

integer

CommunicationChannel

0 = Default; 1 = WhatsApp; 2 = Telefonia; 3 = Email; 4 = WebChat; 5 = InstagramDirectMessage; 6 = FacebookMessenger; 7 = MicrosoftTeams; 8 = ZildCoach

integer

ConversationDataCollectionDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`name`	`string`	Não	—	aceita null
`value`	`string`	Não	—	aceita null
`conversationId`	`integer · int32`	Não	—	—

ConversationDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`active`	`boolean`	Não	—	—
`title`	`string`	Não	—	aceita null
`liveAgent`	`boolean`	Não	—	—
`from`	`string`	Não	—	aceita null
`conversationId`	`string`	Não	—	aceita null
`waterMark`	`string`	Não	—	aceita null
`token`	`string`	Não	—	aceita null
`createdAt`	`string · date-time`	Não	—	—
`finishedAt`	`string · date-time`	Não	—	aceita null
`queuedAt`	`string · date-time`	Não	—	aceita null
`lastConversationUpdateTime`	`string · date-time`	Não	—	—
`lastMessageContent`	`string`	Não	—	aceita null
`contactId`	`integer · int32`	Não	—	—
`contactName`	`string`	Não	—	aceita null
`userId`	`integer · int32`	Não	—	—
`userName`	`string`	Não	—	aceita null
`counterpartUserId`	`integer · int32`	Não	—	—
`counterpartUserName`	`string`	Não	—	aceita null
`botId`	`integer · int32`	Não	—	—
`botName`	`string`	Não	—	aceita null
`fileUrl`	`string`	Não	—	aceita null
`fileName`	`string`	Não	—	aceita null
`tenantId`	`integer · int32`	Não	—	—
`conversationSummary`	`string`	Não	—	aceita null
`messages`	`array<MessageDto>`	Não	—	aceita null
`score`	`integer · int32`	Não	—	—
`finalScore`	`integer · int32`	Não	—	—
`checklistId`	`integer · int32`	Não	—	—
`communicationChannel`	`CommunicationChannel`	Não	—	—
`conversationIntegrationType`	`ConversationIntegrationType`	Não	—	—
`duration`	`string · date-span`	Não	—	aceita null
`highImportanceErrorDetected`	`boolean`	Não	—	—
`tags`	`array<TagDto>`	Não	—	aceita null
`conversationEvaluationStatus`	`ConversationEvaluationStatus`	Não	—	—
`conversationEvaluationStatusMessage`	`string`	Não	—	aceita null
`queueId`	`integer · int32`	Não	—	—
`queueName`	`string`	Não	—	aceita null
`conversationEndedReasonId`	`integer · int32`	Não	—	—
`agentType`	`AgentType`	Não	—	—
`conversationType`	`ConversationType`	Não	—	—
`applicationStatusId`	`integer · int32`	Não	—	—
`overallSentiment`	`string`	Não	—	aceita null
`callStatus`	`string`	Não	—	aceita null
`disconnectionReason`	`string`	Não	—	aceita null
`callSuccessful`	`boolean`	Não	—	—
`totalUnreadedMessagesByUser`	`integer · int32`	Não	—	—
`dynamicVariables`	`array<ConversationDynamicVariableDto>`	Não	—	aceita null
`dataCollection`	`array<ConversationDataCollectionDto>`	Não	—	aceita null
`agentId`	`integer · int32`	Não	—	—
`loadingResponse`	`boolean`	Não	—	—

ConversationDynamicVariableDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`name`	`string`	Não	—	aceita null
`value`	`string`	Não	—	aceita null
`conversationId`	`integer · int32`	Não	—	—

ConversationEvaluationStatus

0 = NotStarted; 1 = InProgress; 2 = Success; 3 = Error; 4 = Ineligible

integer

ConversationIntegrationType

0 = None; 1 = Olus; 2 = TotalIP; 3 = MicrosoftTeams; 4 = Fluctus; 5 = OpaSuite; 6 = ChatMix; 7 = MKBOOT; 8 = FocusChat; 9 = Tallos; 10 = SZFortics; 11 = James; 12 = MatrixGo; 13 = Twilio; 14 = Native; 15 = Internal; 16 = RetellAI; 17 = ElevenLabs; 18 = Email; 19 = WhatsAppApi; 20 = WebChat

integer

ConversationType

0 = ZildAssist; 1 = ZildInsight; 2 = AiSdrReactive; 3 = AiSdrProactive; 4 = AiHrInterview; 5 = ZildCoach; 6 = ZildVoice; 99 = Agent

integer

MessageDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`createdAt`	`string · date-time`	Não	—	—
`from`	`string`	Não	—	aceita null
`to`	`string`	Não	—	aceita null
`content`	`string`	Não	—	aceita null
`conversationId`	`integer · int32`	Não	—	—
`sentiment`	`string`	Não	—	aceita null
`offset`	`string`	Não	—	aceita null
`isNPS`	`boolean`	Não	—	—
`contentSid`	`string`	Não	—	aceita null
`messageType`	`MessageType`	Não	—	—
`conversationTemplateId`	`integer · int32`	Não	—	—
`mediaUrl`	`string`	Não	—	aceita null
`mediaFileName`	`string`	Não	—	aceita null
`tenantId`	`integer · int32`	Não	—	—
`userId`	`integer · int32`	Não	—	—
`contentVariables`	`string`	Não	—	aceita null
`messageSid`	`string`	Não	—	aceita null
`messageStatus`	`MessageStatus`	Não	—	—
`sent`	`boolean`	Não	—	—
`delivered`	`boolean`	Não	—	—
`read`	`boolean`	Não	—	—
`errorCode`	`string`	Não	—	aceita null
`errorMessage`	`string`	Não	—	aceita null
`isReadByUser`	`boolean`	Não	—	—
`documentId`	`integer · int32`	Não	—	aceita null

MessageStatus

0 = Queued; 1 = Sending; 2 = Sent; 3 = Delivered; 4 = Receiving; 5 = Received; 6 = Accepted; 7 = Scheduled; 8 = Read; 9 = Undelivered; 10 = Canceled; 11 = Failed

integer

MessageType

0 = Text; 1 = Image; 2 = File; 3 = Audio; 4 = Video; 5 = Internal; 6 = TemplateMarketing; 7 = TemplateUtility; 8 = Location; 9 = Contact

integer

TagDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`name`	`string`	Não	—	aceita null
`active`	`boolean`	Não	—	—
`createdAt`	`string · date-time`	Não	—	—
`tenantId`	`integer · int32`	Não	—	—