User State

Page describing the user state API

Get user state

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

This endpoint retrieve a specific user state.

Path Parameters

Name	Type	Description
userId	string	User phone number. (Without the "+" sign)

200

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

400

{
  "message": [
    "Error getting user state."
  ],
  "status": "failed"
}

Change user state

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

This endpoint allows you to change the state of the user from manual to automatic or the other way around.

Request Body

Name	Type	Description
ttl	number	Manual state expiration time
botId	string	Bot id
userId	string	User phone number. (Without the "+" sign)
state	string	State of the user that we want to change it for. (Option: "manual" or "auto")

200

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

400 User state could not be set.

{
  "message": [
    "User state could not been set."
  ],
  "status": "failed"
}

Take to account that when the bot is set to manual, answers won't be replied and sent by the bot to the chatbot user. To answer in manual state is up to you. The sending messages endpoints must be used for answering when the user is in manual state.