Skip to main content

Добавление сообщения в избранное

Метод и конечная точка​

POST /chat.starMessage

Описание​

Добавляет сообщение в избранное для текущего пользователя.

Параметры​

Перечень параметров представлен в таблице.

НазваниеОбязательныйТип данныхОписание
messageIdдаstringИдентификатор сообщения

Запрос​

curl -X 'POST' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.starMessage' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>' \
-d '{ \
"messageId": "<MESSAGE_ID>"
}'

Где:

  • <ENV> — окружение, на котором выполняется запрос;
  • <DEFAULT_DOMAIN> — домен сервера Squadus;
  • <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
  • <AUTH_TOKEN> — токен аутентификации пользователя;
  • <MESSAGE_ID> — идентификатор сообщения для добавления в избранное.

Ответ​

200 — Result of star message — Сообщение добавлено в избранное. Пример вывода:

{
"success": true
}