Consultar conversa

Get Conversation

curl --request GET \
  --url https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

GET

external-support

{projectId}

conversations

{conversationId}

Get Conversation

curl --request GET \
  --url https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://gateway.jelou.ai/platform/v1/external-support/{projectId}/conversations/{conversationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

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/platform/v1/external-support/{projectId}/conversations/{conversationId}

Parâmetros de rota

string

obrigatório

Identificador único do projeto Jelou ao qual a conversa pertence.

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/platform/v1/external-support/PROJECT_ID/conversations/CONVERSATION_ID \
  --header 'x-api-key: API_KEY'

Respostas

Código	Status	Descrição
200	OK	Conversa encontrada. Retorna os detalhes da conversa.
401	Unauthorized	Credenciais de autenticação inválidas ou ausentes.
404	Not Found	Conversa não encontrada para os identificadores indicados.
500	Internal Server Error	Erro 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

Campo	Tipo	Descrição
`data._id`	string	Identificador único da conversa.
`data.roomId`	string	Identificador da sala de conversa.
`data.state`	string	Status da conversa: `active` ou `closed`.
`data.startAt`	date	Data e hora de início da conversa.
`data.endAt`	date	Data e hora de encerramento. Presente apenas se a conversa estiver encerrada.
`data.endedReason`	string	Motivo do encerramento: `closed_by_operator`.
`data.User.id`	string	Identificador do usuário final.
`data.User.names`	string	Nome do usuário final.
`data.User.referenceId`	string	Identificador de referência externo do usuário.
`data.Bot.id`	string	Identificador do bot que atendeu a conversa.
`data.Bot.name`	string	Nome do bot.
`data.Bot.type`	string	Canal do bot (por exemplo: `Whatsapp`).

Autorizações

x-api-key

string

header

obrigatório

API key del proyecto de Jelou

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

Encerrar conversa

Receber mensagem do usuário final

⌘I

Referência de API

Enviar Mensagens

Campanhas

Conversações

Métricas

Usuários

Recursos

Widget

Datum

Painel de Atendimento Externo

Gestão de Memória

Descrição

Endpoint

Parâmetros de rota

Autenticação

Exemplo de requisição

Respostas

Exemplo de resposta

Estrutura da resposta

Autorizações

Parâmetros de caminho

Resposta

​Descrição

​Endpoint

​Parâmetros de rota

​Autenticação

​Exemplo de requisição

​Respostas

​Exemplo de resposta

​Estrutura da resposta

Autorizações

Parâmetros de caminho

Resposta

Descrição

Endpoint

Parâmetros de rota

Autenticação

Exemplo de requisição

Respostas

Exemplo de resposta

Estrutura da resposta