Pular para o conteúdo principal
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"
}

​
Descrição

Gerencie o status operacional de um usuário dentro do seu bot. Você pode verificar se um contato está no modo manual ou automático e atualizar essa configuração para controlar quem responde às conversas.

​
Obter Status do Usuário

​
Endpoint

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

​
Parâmetros de Path

​
userId
string
obrigatório
Número de telefone do usuário (sem o sinal +).

​
Exemplo de Resposta

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

​
Alterar Status do Usuário

​
Endpoint

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

​
Corpo da Requisição

​
ttl
number
Tempo em segundos que o estado manual permanecerá antes de expirar automaticamente.
​
botId
string
obrigatório
Identificador do bot associado ao usuário.
​
userId
string
obrigatório
Número de telefone do usuário (sem o sinal +).
​
state
string
obrigatório
Estado alvo. Valores permitidos: "manual" ou "auto".

​
Exemplo de Requisição

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"
  }'

​
Exemplo de Resposta

{
  "id": "573001234567",
  "names": "John Doe",
  "botId": "bot-12345",
  "groupId": "grp-67890",
  "state": "manual"
}
Quando um usuário está no estado manual, o bot para de responder automaticamente e mensagens manuais devem ser enviadas usando os endpoints de envio. Certifique-se de coordenar a mudança de estado com sua equipe de suporte.

​
Erros Comuns

  • 400 - Não foi possível obter ou atualizar o status do usuário.
  • 401 - Credenciais inválidas ou ausentes.
  • 404 - Usuário ou bot não encontrado.

Autorizações

​
Authorization
string
header
obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de caminho

​
userId
string
obrigatório

Phone number without + sign

Resposta

User state retrieved

​
id
string
​
names
string
​
botId
string
​
groupId
string
​
state
enum<string>
Opções disponíveis:
auto,
manual