Saltar al contenido 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 no emite ningún evento al webhook. Es una consulta de solo lectura para obtener el estado actual de una conversación.

​
Descripción

Consulta los detalles y el estado actual de una conversación específica. Devuelve información del usuario, el bot asociado, las fechas de inicio y cierre, y la razón de finalización si aplica.

​
Endpoint

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

​
Parámetros de ruta

​
projectId
string
requerido
Identificador único del proyecto de Jelou al que pertenece la conversación.
​
conversationId
string
requerido
Identificador único de la conversación que se desea consultar.

​
Autenticación

Todas las peticiones deben incluir el encabezado x-api-key con la API key del proyecto de Jelou. 
x-api-key: API_KEY

​
Ejemplo de solicitud

El siguiente ejemplo consulta los detalles de la conversación CONVERSATION_ID dentro del proyecto 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'

​
Respuestas

CódigoEstadoDescripción
200OKConversación encontrada. Devuelve los detalles de la conversación.
401UnauthorizedCredenciales de autenticación inválidas o faltantes.
404Not FoundConversación no encontrada para los identificadores indicados.
500Internal Server ErrorError interno del servidor.

​
Ejemplo de respuesta

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

​
Estructura de la respuesta

CampoTipoDescripción
data._idstringIdentificador único de la conversación.
data.roomIdstringIdentificador de la sala de conversación.
data.statestringEstado de la conversación: active o closed.
data.startAtdateFecha y hora de inicio de la conversación.
data.endAtdateFecha y hora de cierre. Presente solo si la conversación está cerrada.
data.endedReasonstringRazón del cierre: closed_by_operator.
data.User.idstringIdentificador del usuario final.
data.User.namesstringNombre del usuario final.
data.User.referenceIdstringIdentificador de referencia externo del usuario.
data.Bot.idstringIdentificador del bot que atendió la conversación.
data.Bot.namestringNombre del bot.
data.Bot.typestringCanal del bot (por ejemplo: Whatsapp).

Autorizaciones

​
Authorization
string
header
requerido

Basic authentication using Base64 encoded clientId:clientSecret

Parámetros de ruta

​
projectId
string
requerido

Unique identifier of the Jelou project

​
conversationId
string
requerido

Unique identifier of the conversation

Respuesta

Conversation retrieved successfully