Estado de Usuario

Cómo usar la API para obtener y cambiar el estado de un usuario.

Obtener estado de usuario

Este endpoint recupera un estado de usuario específico.

GET https://api.jelou.ai/v1/users/:userId/state

Parámetros de ruta:

Propiedad	Tipo de dato	Descripción
userId	string	Número de teléfono del usuario (sin el signo "+").

Respuesta exitosa (200):

    "id": "<userId>",
    "names": "<userNames>",
    "botId": "<botId>",
    "groupId": "<groupId>",
    "state": "<state>"

Error (400):

  "message": [
    "Error al obtener el estado del usuario."
  ],
  "status": "failed"

Cambiar el estado del usuario

Este endpoint permite cambiar el estado de un usuario de manual a automático o viceversa:

POST https://api.jelou.ai/v1/users/state

Cuerpo de la solicitud:

Propiedad	Tipo de dato	Descripción
ttl	number	Tiempo de expiración del estado manual.
botId	string	ID del bot.
userId	string	Número de teléfono del usuario (sin el signo "+").
state	string	Estado al que se desea cambiar al usuario (opciones: "manual" o "auto").

Respuesta exitosa (200):

    "id": "<userId>",
    "names": "<userNames>",
    "botId": "<botId>",
    "groupId": "<groupId>",
    "state": "<state>"

Respuesta de error (400):

  "message": [
    "No se pudo establecer el estado del usuario."
  ],
  "status": "failed"

precaución

💡 Cuando el bot está configurado en estado manual, las respuestas no serán enviadas automáticamente por el bot al usuario del chatbot. En este caso, es responsabilidad del usuario responder. Se deben utilizar los endpoints de envío de mensajes para responder cuando el usuario está en estado manual.:::