Skip to main content
POST
Close Conversation

Descrição

Encerra uma conversa ativa no painel de atendimento externo. Permite especificar uma mensagem de encerramento que será enviada ao usuário e o motivo do encerramento. Ao ser executado, o Jelou emite o evento conversation.close para o webhook configurado na integração.

Endpoint

Parâmetros de rota

string
obrigatório
Identificador único do projeto Jelou a partir do qual a conversa é encerrada.

Parâmetros do corpo

string
obrigatório
Identificador do bot do Jelou associado à conversa.
string
obrigatório
Identificador do usuário final cuja conversa se deseja encerrar.
object
Mensagem que será enviada ao usuário no momento do encerramento da conversa.
  • type — Tipo de mensagem: text ou edge.
  • text — Texto da mensagem de encerramento (quando type é text).

Autenticação

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

Exemplo de requisição

O exemplo a seguir encerra a conversa do usuário USER_ID e inclui uma mensagem de encerramento:
cURL

Respostas

Exemplo de resposta


Evento webhook conversation.close

Ao executar este recurso, o Jelou emitirá o evento conversation.close ao webhook configurado na integração. O payload inclui o motivo do encerramento e a mensagem enviada ao usuário.

Campos do payload

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

Corpo

application/json
botId
string
obrigatório
userId
string
obrigatório
redirectPayload
object

Resposta

Conversation closed successfully