Отметка сообщений как прочитанных
Метод и конечная точка
POST /chat.readMessages
Описание
Отмечает сообщения в комнате как прочитанные. Параметры аналогичны Meteor.call readMessages.
Параметры
Перечень параметров представлен в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| rid | да | string | Идентификатор комнаты |
| readToMessageId | нет | string | Идентификатор последнего прочитанного сообщения |
| readThreads | нет | boolean | Отметить ветки в комнате как прочитанные |
Запрос
curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.readMessages' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"rid": "<ROOM_ID>",
"readToMessageId": "<MESSAGE_ID>",
"readThreads": true
}'
Где:
<ENV>— окружение, на котором выполняется запрос;<DEFAULT_DOMAIN>— домен сервера Squadus;<USER_ID>— идентификатор пользователя, от имени которого выполняется запрос;<AUTH_TOKEN>— токен аутентификации пользователя;<ROOM_ID>— идентификатор комнаты;<MESSAGE_ID>— идентификатор последнего прочитанного сообщения.
Ответ
200 — Successfully read room messages — Сообщения отмечены как прочитанные. Пример вывода:
{
"success": true,
"result": 5
}