Skip to main content
GET
/
v1
/
users
/
{userId}
/
state
Get User State
curl --request GET \
  --url https://api.jelou.ai/v1/users/{userId}/state \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "names": "<string>",
  "botId": "<string>",
  "groupId": "<string>",
  "state": "auto"
}

​
Descripción

Gestiona el estado operativo de un usuario dentro de tu bot. Puedes consultar si un contacto está en modo manual o automático y actualizar esta configuración para controlar quién responde las conversaciones.

​
Obtener el Estado de un Usuario

​
Endpoint

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

​
Parámetros de Ruta

​
userId
string
required
Número de teléfono del usuario (sin el signo +).

​
Ejemplo de Respuesta

{
  "id": "573001234567",
  "names": "John Doe",
  "botId": "bot-12345",
  "groupId": "grp-67890",
  "state": "auto"
}

​
Cambiar el Estado de un Usuario

​
Endpoint

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

​
Cuerpo de la Solicitud

​
ttl
number
Tiempo en segundos que permanecerá el estado manual antes de expirar automáticamente.
​
botId
string
required
Identificador del bot asociado al usuario.
​
userId
string
required
Número de teléfono del usuario (sin el signo +).
​
state
string
required
Estado objetivo. Valores permitidos: "manual" o "auto".

​
Ejemplo de Solicitud

cURL
curl --request POST \
  --url https://api.jelou.ai/v1/users/state \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "ttl": 3600,
    "botId": "bot-12345",
    "userId": "573001234567",
    "state": "manual"
  }'

​
Ejemplo de Respuesta

{
  "id": "573001234567",
  "names": "John Doe",
  "botId": "bot-12345",
  "groupId": "grp-67890",
  "state": "manual"
}
Cuando un usuario está en estado manual, el bot deja de responder automáticamente y es necesario enviar mensajes manuales usando los endpoints de envío. Asegúrate de coordinar el cambio de estado con tu equipo de soporte.

​
Errores Comunes

  • 400 - No se pudo obtener o actualizar el estado del usuario.
  • 401 - Credenciales inválidas o faltantes.
  • 404 - Usuario o bot no encontrados.

Authorizations

​
Authorization
string
header
required

Basic authentication using Base64 encoded clientId:clientSecret

Path Parameters

​
userId
string
required

Phone number without + sign

Response

User state retrieved

​
id
string
​
names
string
​
botId
string
​
groupId
string
​
state
enum<string>
Available options:
auto,
manual