Skip to main content
POST
Close Conversation

Descripción

Cierra una conversación activa en el panel de atención externo. Permite especificar un mensaje de cierre que se enviará al usuario y la razón del cierre. Al ejecutarse, Jelou emite el evento conversation.close hacia el webhook configurado en la integración.

Endpoint

Parámetros de ruta

string
requerido
Identificador único del proyecto de Jelou desde el que se cierra la conversación.

Parámetros del cuerpo

string
requerido
Identificador del bot de Jelou asociado a la conversación.
string
requerido
Identificador del usuario final cuya conversación se desea cerrar.
object
Mensaje que se enviará al usuario al momento del cierre de la conversación.
  • type — Tipo de mensaje: text o edge.
  • text — Texto del mensaje de cierre (cuando type es text).

Autenticación

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

Ejemplo de solicitud

El siguiente ejemplo cierra la conversación del usuario USER_ID e incluye un mensaje de cierre:
cURL

Respuestas

Ejemplo de respuesta


Evento webhook conversation.close

Al ejecutar este recurso, Jelou emitirá el evento conversation.close al webhook configurado en la integración. El payload incluye la razón del cierre y el mensaje enviado al usuario.

Campos del payload

Autorizaciones

x-api-key
string
header
requerido

API key del proyecto de Jelou

Parámetros de ruta

projectId
string
requerido

Unique identifier of the Jelou project

Cuerpo

application/json
botId
string
requerido
userId
string
requerido
redirectPayload
object

Respuesta

Conversation closed successfully