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

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

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

URL

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

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

Аргументы

Этот метод следует общим правилам. Аргументы передаются как GET или POST параметры.

Аргумент Описание
auth_token Обязательный. Токен авторизации (нужен scope: user-write)
presence Обязательный. Статус: online или idle
session Обязательный. Идентификатор сессии

Пользователь может быть онлайн с разных устройств или браузеров. Каждое такое устройство или браузер — отдельная сессия. Нужно сгенерировать случайный идентификатор [a-z0-9]{32} (32 символа, маленькие латинские букв и цифры), чтобы Carrot quest мог различать сессии.

Например, в случае веб-браузера, мы сохраняем идентификатор сессии в куке со временем жизни до закрытия браузера. Пример сессии: dksjovtd9e1nz6hpbk2adkj1fwwfwzfd.

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

Ответ

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

Ответ будет пустым.

Примеры

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