Отправить heartbeat сигнал

Этот метод отправляет heartbeat сигнал пользователя. Мы вызываем его на стороне пользователя на сайте чтобы отслеживать статусы пользователей.

Этот метод нужно вызывать каждую минуту.

URL

POST https://api.carrotquest.io/users/{id}/setpresence

Вместо {id} нужно подставить ID пользователя из нашей системы.

Параметры

Параметры аутентификации.

Параметр	Тип	Описание
presence	строка	Статус: online или idle
current_page	Optional[строка]	Название страницы, с которой отправлен запрос
current_url	Optional[строка]	URL страницы, с которой пришел запрос
app	Optional[ID]	ID приложения, делающего запрос. По умолчанию определяется на основе токена доступа.

Замечания

Пользователь может быть онлайн с разных устройств или браузеров.
Поля current_page и current_url используются, чтобы отслеживать текущую страницу пользователя. Значение, переданное в этих полях, используется в фильтрах автосообщений и ботов.

Пользователь считается спящим (idle), если он не проявляет никакой активности в течение двух минут (не нажимает клавиш, не скроллит, не двигает мышкой и т. д.).

Ответ

Поле data ответа будет пустым.
Поле meta ответа будет стандартным.

{
  "meta": {
    "status": 200
  },
  "data": {
  }
}

Ошибки

Стандартные ошибки Web API.

Примеры

curl -X POST \
  --data-urlencode 'presence=online' \
  --data-urlencode 'session=dksjovtd9e1nz6hpbk2adkj1fwwfwzfd' \
  -H "Authorization: Token XXX" \
  "https://api.carrotquest.io/users/2137216/setpresence"