Pular para o conteúdo principal
GET
/
v1
/
external-support
/
{projectId}
/
conversations
/
{conversationId}
Get Conversation
curl --request GET \
  --url https://gateway.jelou.ai/jelouapi/v1/external-support/{projectId}/conversations/{conversationId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt

Use this file to discover all available pages before exploring further.

Este endpoint não emite nenhum evento ao webhook. É uma consulta somente leitura para obter o status atual de uma conversa.

​
Descrição

Consulta os detalhes e o status atual de uma conversa específica. Retorna informações do usuário, o bot associado, as datas de início e encerramento, e o motivo do encerramento se aplicável.

​
Endpoint

GET https://gateway.jelou.ai/jelouapi/v1/external-support/{projectId}/conversations/{conversationId}

​
Parâmetros de rota

​
projectId
string
obrigatório
Identificador único do projeto Jelou ao qual a conversa pertence.
​
conversationId
string
obrigatório
Identificador único da conversa que se deseja consultar.

​
Autenticação

Todas as requisições devem incluir o cabeçalho x-api-key com a API key do projeto Jelou. 
x-api-key: API_KEY

​
Exemplo de requisição

O exemplo a seguir consulta os detalhes da conversa CONVERSATION_ID dentro do projeto PROJECT_ID:
cURL
curl --request GET \
  --url https://gateway.jelou.ai/jelouapi/v1/external-support/PROJECT_ID/conversations/CONVERSATION_ID \
  --header 'x-api-key: API_KEY'

​
Respostas

CódigoStatusDescrição
200OKConversa encontrada. Retorna os detalhes da conversa.
401UnauthorizedCredenciais de autenticação inválidas ou ausentes.
404Not FoundConversa não encontrada para os identificadores indicados.
500Internal Server ErrorErro interno do servidor.

​
Exemplo de resposta

{
  "message": [
    "Conversation retrieved successfully"
  ],
  "statusMessage": "success",
  "status": 1,
  "data": {
    "_id": "CONVERSATION_ID",
    "roomId": "ROOM_ID",
    "state": "closed",
    "startAt": "2026-01-15T10:30:00.000Z",
    "endAt": "2026-01-15T10:45:00.000Z",
    "endedReason": "closed_by_operator",
    "User": {
      "id": "USER_ID",
      "names": "USER_NAME",
      "referenceId": "USER_REFERENCE_ID",
      "createdAt": "2025-01-28T20:54:25.572Z"
    },
    "Bot": {
      "id": "BOT_ID",
      "name": "BOT_NAME",
      "type": "Whatsapp"
    }
  }
}

​
Estrutura da resposta

CampoTipoDescrição
data._idstringIdentificador único da conversa.
data.roomIdstringIdentificador da sala de conversa.
data.statestringStatus da conversa: active ou closed.
data.startAtdateData e hora de início da conversa.
data.endAtdateData e hora de encerramento. Presente apenas se a conversa estiver encerrada.
data.endedReasonstringMotivo do encerramento: closed_by_operator.
data.User.idstringIdentificador do usuário final.
data.User.namesstringNome do usuário final.
data.User.referenceIdstringIdentificador de referência externo do usuário.
data.Bot.idstringIdentificador do bot que atendeu a conversa.
data.Bot.namestringNome do bot.
data.Bot.typestringCanal do bot (por exemplo: Whatsapp).

Autorizações

​
Authorization
string
header
obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de caminho

​
projectId
string
obrigatório

Unique identifier of the Jelou project

​
conversationId
string
obrigatório

Unique identifier of the conversation

Resposta

Conversation retrieved successfully