GET /chat/message/unread

Метод позволяет узнавать, есть ли непрочитанные сообщения.

Формат запроса

GET https://apiauto.ru/1.0/chat/message/unread/

Заголовки запроса

Заголовок

Описание

x-session-id

Идентификатор сессии пользователя. Значение можно получить с помощью операции POST /auth/login

x-authorization

Авторизационный токен. См. подробнее Доступ к API

Формат ответа

{
  "has_unread": true,
  "unread_counter": 2,
  "status": "SUCCESS"
}

has_unread

Наличие непрочитанных сообщений в чате. Допустимые значения:

true — есть;
false — нет


unread_counter

Количество непрочитанных сообщений в чате


status

Статус выполнения запроса. Возможные значения: SUCCESS, ERROR


Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

401

NO_AUTH

Не удалось авторизовать пользователя по переданным данным.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -X 'GET' \
 'https://apiauto.ru/1.0/chat/message/unread' \
 -H 'accept: application/json' \
 -H 'x-session: ...' \
 -H 'x-authorization: ...' 

Ответ:

{
 "has_unread": true,
 "unread_counter": 2,
 "status": "SUCCESS"
}
Предыдущая
Следующая